Adjustments for CRAN upload

[valse.git] / pkg / R / initSmallEM.R

diff --git a/pkg/R/initSmallEM.R b/pkg/R/initSmallEM.R
index 10cb191..3945322 100644 (file)
--- a/pkg/R/initSmallEM.R
+++ b/pkg/R/initSmallEM.R
@@ -1,3 +1,5 @@
+#' initSmallEM
+#'
 #' initialization of the EM algorithm
 #'
 #' @param k number of components
@@ -5,9 +7,12 @@
 #' @param Y matrix of responses (of size n*m)
 #' @param fast boolean to enable or not the C function call
 #'
-#' @return a list with phiInit, rhoInit, piInit, gamInit
+#' @return a list with phiInit (the regression parameter reparametrized),
+#' rhoInit (the covariance parameter reparametrized), piInit (the proportion parameter is the
+#' mixture model), gamInit (the conditional expectation)
 #'
 #' @importFrom stats cutree dist hclust runif
+#'
 #' @export
 initSmallEM <- function(k, X, Y, fast)
 {