[Vegan-commits] r2167 - pkg/vegan/man

[noreply at r-forge.r-project.org]

Author: jarioksa
Date: 2012-05-11 10:08:41 +0200 (Fri, 11 May 2012)
New Revision: 2167

Modified:
   pkg/vegan/man/ordiplot3d.Rd
Log:
add warning of possible unequal aspect ratio in ordiplot3d

Modified: pkg/vegan/man/ordiplot3d.Rd
===================================================================
--- pkg/vegan/man/ordiplot3d.Rd	2012-05-11 07:50:28 UTC (rev 2166)
+++ pkg/vegan/man/ordiplot3d.Rd	2012-05-11 08:08:41 UTC (rev 2167)
@@ -158,6 +158,20 @@
   that \code{\link[rgl]{rgl.texts}} does  not always position the text
   like supposed, and it may be safe to verify text location with
   corresponding points.
+
+  Function \code{ordiplot3d} is based on
+  \code{\link[scatterplot3d]{scatterplot3d}} which does not allow
+  exactly setting equal aspect ratio for axes.  The function tries to
+  circumvent this by setting equal plotting ranges for all axes so that
+  the plot should be a cube.  Depending on the dimensions of plotting
+  device, this may fail, and the user should verify that the axes are
+  approximately equal.
+
+  Please note that \code{\link[scatterplot3d]{scatterplot3d}} sets
+  internally some graphical parameters (such as \code{mar} for margins)
+  and does not honour default settings.  It is advisable to study
+  carefully the documentation and examples of
+  \code{\link[scatterplot3d]{scatterplot3d}}.
 }
 
 \note{The user interface of \pkg{rgl} changed in version 0.65, but