X-Git-Url: https://git.auder.net/?p=valse.git;a=blobdiff_plain;f=pkg%2FR%2Fmain.R;h=d750fec8f1e0e9b56f578908653424519b6d878c;hp=8649342b8d727ce79bdd00fe94c3753c6412485a;hb=1196a43d961a95abc18d3c8e777e9a4e8233e562;hpb=0ba1b11c49d7b2a0cae493200793c1ba3fb8b8e7

diff --git a/pkg/R/main.R b/pkg/R/main.R
index 8649342..d750fec 100644
--- a/pkg/R/main.R
+++ b/pkg/R/main.R
@@ -1,4 +1,4 @@
-#' valse
+#' runValse
 #'
 #' Main function
 #'
@@ -21,13 +21,15 @@
 #' @param size_coll_mod (Maximum) size of a collection of models
 #' @param fast TRUE to use compiled C code, FALSE for R code only
 #' @param verbose TRUE to show some execution traces
+#' @param plot TRUE to plot the selected models after run
 #'
 #' @return a list with estimators of parameters
 #'
 #' @examples
 #' #TODO: a few examples
+#'
 #' @export
-valse <- function(X, Y, procedure = "LassoMLE", selecMod = "DDSE", gamma = 1, mini = 10,
+runValse <- function(X, Y, procedure = "LassoMLE", selecMod = "DDSE", gamma = 1, mini = 10,
   maxi = 50, eps = 1e-04, kmin = 2, kmax = 3, rank.min = 1, rank.max = 5, ncores_outer = 1,
   ncores_inner = 1, thresh = 1e-08, grid_lambda = numeric(0), size_coll_mod = 10,
   fast = TRUE, verbose = FALSE, plot = TRUE)