Some fixes + refactoring

[agghoo.git] / man / compareMulti.Rd

diff --git a/man/compareMulti.Rd b/man/compareMulti.Rd
new file mode 100644 (file)
index 0000000..8bf537e
--- /dev/null
+++ b/man/compareMulti.Rd
@@ -0,0 +1,39 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/compareTo.R
+\name{compareMulti}
+\alias{compareMulti}
+\title{compareMulti}
+\usage{
+compareMulti(
+  data,
+  target,
+  method_s,
+  N = 100,
+  nc = NA,
+  floss = NULL,
+  verbose = TRUE,
+  ...
+)
+}
+\arguments{
+\item{data}{Data matrix or data.frame}
+
+\item{target}{Target vector (generally)}
+
+\item{method_s}{Either a single function, or a list
+(examples: agghoo_run, standardCV_run)}
+
+\item{N}{Number of calls to method(s)}
+
+\item{nc}{Number of cores. Set to parallel::detectCores() if undefined.
+Set it to any value <=1 to say "no parallelism".}
+
+\item{floss}{Loss function to compute the error on testing dataset.}
+
+\item{verbose}{TRUE to print task numbers and "Errors:" in the end.}
+
+\item{...}{arguments passed to method_s function(s)}
+}
+\description{
+Run compareTo N times in parallel.
+}