X-Git-Url: https://git.auder.net/?p=agghoo.git;a=blobdiff_plain;f=man%2FAgghooCV.Rd;fp=man%2FAgghoo.Rd;h=4d4cf78b7d4d84c614c6c447a1125335709489bc;hp=dc70db603ef0667721aaef1524a1bb0b66853247;hb=cca5f1c67bd622fb7bc1279dfe4c3336d1446efd;hpb=d09659f0e609bc8c1a6c390329d8f2d3b3ac5b24
diff --git a/man/Agghoo.Rd b/man/AgghooCV.Rd
similarity index 78%
rename from man/Agghoo.Rd
rename to man/AgghooCV.Rd
index dc70db6..4d4cf78 100644
--- a/man/Agghoo.Rd
+++ b/man/AgghooCV.Rd
@@ -1,7 +1,7 @@
% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/R6_Agghoo.R
-\name{Agghoo}
-\alias{Agghoo}
+% Please edit documentation in R/R6_AgghooCV.R
+\name{AgghooCV}
+\alias{AgghooCV}
\title{R6 class with agghoo functions fit() and predict().}
\description{
Class encapsulating the methods to run to obtain the best predictor
@@ -10,19 +10,19 @@ from the list of models (see 'Model' class).
\section{Methods}{
\subsection{Public methods}{
\itemize{
-\item \href{#method-new}{\code{Agghoo$new()}}
-\item \href{#method-fit}{\code{Agghoo$fit()}}
-\item \href{#method-predict}{\code{Agghoo$predict()}}
-\item \href{#method-clone}{\code{Agghoo$clone()}}
+\item \href{#method-new}{\code{AgghooCV$new()}}
+\item \href{#method-fit}{\code{AgghooCV$fit()}}
+\item \href{#method-predict}{\code{AgghooCV$predict()}}
+\item \href{#method-clone}{\code{AgghooCV$clone()}}
}
}
\if{html}{\out{
}}
\if{html}{\out{}}
\if{latex}{\out{\hypertarget{method-new}{}}}
\subsection{Method \code{new()}}{
-Create a new Agghoo object.
+Create a new AgghooCV object.
\subsection{Usage}{
-\if{html}{\out{}}\preformatted{Agghoo$new(data, target, task, gmodel, quality = NA)}\if{html}{\out{
}}
+\if{html}{\out{}}\preformatted{AgghooCV$new(data, target, task, gmodel, quality = NA)}\if{html}{\out{
}}
}
\subsection{Arguments}{
@@ -48,7 +48,7 @@ quality(y1, y2) --> real number}
\subsection{Method \code{fit()}}{
Fit an agghoo model.
\subsection{Usage}{
-\if{html}{\out{}}\preformatted{Agghoo$fit(
+\if{html}{\out{
}}\preformatted{AgghooCV$fit(
CV = list(type = "MC", V = 10, test_size = 0.2, shuffle = TRUE),
mode = "agghoo"
)}\if{html}{\out{
}}
@@ -76,7 +76,7 @@ Fit an agghoo model.
\subsection{Method \code{predict()}}{
Predict an agghoo model (after calling fit())
\subsection{Usage}{
-\if{html}{\out{
}}\preformatted{Agghoo$predict(X, weight = "uniform")}\if{html}{\out{
}}
+\if{html}{\out{
}}\preformatted{AgghooCV$predict(X, weight = "uniform")}\if{html}{\out{
}}
}
\subsection{Arguments}{
@@ -96,7 +96,7 @@ average models performances (TODO: bad idea?!)}
\subsection{Method \code{clone()}}{
The objects of this class are cloneable with this method.
\subsection{Usage}{
-\if{html}{\out{
}}\preformatted{Agghoo$clone(deep = FALSE)}\if{html}{\out{
}}
+\if{html}{\out{
}}\preformatted{AgghooCV$clone(deep = FALSE)}\if{html}{\out{
}}
}
\subsection{Arguments}{