Defined parameters, removed help as not exported

jfq3 · Aug 1, 2023 · 690ae39 · 690ae39
1 parent f4aa069
commit 690ae39
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 28 deletions.
diff --git a/R/veganCovEllipse.R b/R/veganCovEllipse.R
@@ -2,12 +2,13 @@
 #'
 #' Generates points for ellipse around treatment centroids
 #'
-#' @param cov Covariance extracted from ordination with vegan's ordiellipse function
+#' @param cov Estimated (weighted) covariance matrix extracted from ordination with vegan's ordiellipse function
 #' @param center Coordinates for center of ellipse
-#' @param scale Ellipse dimension in standard deviations
+#' @param scale Scaling factor for ellipse
 #' @param npoints Number of points to generate
 #' @return A dataframe for plotting ellipses around each group centroid.
 #' @author Jari Oksanen
+#' @noRd
 
 veganCovEllipse <-
   function(cov, center = c(0,0), scale = 1, npoints = 100)

diff --git a/man/veganCovEllipse.Rd b/man/veganCovEllipse.Rd