diff --git a/R/TrainLayer.R b/R/TrainLayer.R index 5efd220..1c1cf8a 100644 --- a/R/TrainLayer.R +++ b/R/TrainLayer.R @@ -5,14 +5,14 @@ #' #' A training layer is structured as followed: #' -#' * [Lrner]: It is set by the user to be trained on the training data. -#' * [TrainData]: It is set by the user to be used to train the learner. -#' * [Model]: The result of training the learner on the training data, and therefore, not set by the user. -#' * [TestData]: It is set by the user implements new data to be predicted. +#' * [TrainData]: Data to be used to train the learner. +#' * [Lrner]: Includes a learning function and the package implementing the function. +#' * [Model]: The result of training the learner on the training data. +#' * [VarSel]: Includes a variable selection function and the package implementing the function. #' -#' A layer can train its learner on its training data and store the resulting model. See the public function \code{Layer$train()} below. +#' A training layer can train its learner on its training data and store the resulting model. See the public function \code{Layer$train()} below. #' -#' A layer can make predictions for a new layer passed as argument to its predict function. See the public function \code{Layer$predict()} below. +#' A training layer can make predictions for a new layer passed as argument to its predict function. See the public function \code{Layer$predict()} below. #' #' @export #' @importFrom R6 R6Class diff --git a/R/createTesting.R b/R/createTesting.R index ac65767..63c2f28 100644 --- a/R/createTesting.R +++ b/R/createTesting.R @@ -1,4 +1,6 @@ -#' @title Creates a [Testing] object. +#' @title createTesting +#' @description +#' Creates a [Testing] object. #' #' @param id (`character(1)`) \cr #' Testing id. @@ -17,7 +19,9 @@ createTesting = function (id, } -#' @title Creates and store a [TestLayer] on the [Testing] object passed as argument. +#' @title createTestLayer +#' @description +#' Creates and store a [TestLayer] on the [Testing] object passed as argument. #' #' @param testing (`Testing(1)`) \cr #' Testing object where the created layer will be stored. diff --git a/R/createTraining.R b/R/createTraining.R index d0a94a8..5dd1beb 100644 --- a/R/createTraining.R +++ b/R/createTraining.R @@ -1,4 +1,6 @@ -#' @title Creates a [Training] object. +#' @title createTraining +#' @description +#' Creates a [Training] object. #' #' @param id (`character(1)`) \cr #' @param ind_col (`character(1)`) \cr @@ -31,8 +33,9 @@ createTraining = function (id, return(training) } - -#' @title Creates and store a [TrainLayer] on the [Training] object passed as argument. +#' @title createTrainLayer +#' @description +#' Creates and store a [TrainLayer] on the [Training] object passed as argument. #' #' @param training (`Training(1)`) \cr #' Training object where the created layer will be stored. @@ -102,7 +105,9 @@ createTrainLayer = function (training, -#' @title Creates and store a [TrainMetaLayer] on the [Training] object passed as argument. +#' @title createTrainMetaLayer +#' @description +#' Creates and store a [TrainMetaLayer] on the [Training] object passed as argument. #' #' @param training (`Training(1)`) \cr #' Training object where the created layer will be stored. @@ -146,7 +151,9 @@ createTrainMetaLayer = function (training, return(training) } -#' @title Variable selection on the current training object. +#' @title varSelection +#' @description +#' Variable selection on the current training object. #' #' @param training (`Training(1)`) \cr #' Training object where the created layer will be stored. @@ -166,7 +173,9 @@ varSelection = function (training, return(selected) } -#' @title Trains the [Training] object passed as argument. All leaners and the meta learner are trained. +#' @title fusemlr +#' @description +#' Trains the [Training] object passed as argument. All leaners and the meta learner are trained. #' #' @param training (`Training(1)`) \cr #' Training object where the created layer will be stored. @@ -201,7 +210,9 @@ fusemlr = function (training, -#' @title Computes predictions for the [Testing] object passed as argument. +#' @title predict.Training +#' @description +#' Computes predictions for the [Testing] object passed as argument. #' #' @param object (`Training(1)`) \cr #' Training object to be used to compute predictions. @@ -221,7 +232,9 @@ predict.Training = function (object, return(predictions) } -#' @title An upset plot of overlapping individuals. +#' @title upsetplot +#' @description +#' An upset plot of overlapping individuals. #' #' @param object (`Training(1) or Testing(1)`) \cr #' Training or testing object for each the upset plot will be created. diff --git a/man/TrainLayer.Rd b/man/TrainLayer.Rd index 29af144..b6e19c7 100644 --- a/man/TrainLayer.Rd +++ b/man/TrainLayer.Rd @@ -8,15 +8,15 @@ This class implements a traning layer. A \link{TrainLayer} object can only exist A training layer is structured as followed: \itemize{ -\item \link{Lrner}: It is set by the user to be trained on the training data. -\item \link{TrainData}: It is set by the user to be used to train the learner. -\item \link{Model}: The result of training the learner on the training data, and therefore, not set by the user. -\item \link{TestData}: It is set by the user implements new data to be predicted. +\item \link{TrainData}: Data to be used to train the learner. +\item \link{Lrner}: Includes a learning function and the package implementing the function. +\item \link{Model}: The result of training the learner on the training data. +\item \link{VarSel}: Includes a variable selection function and the package implementing the function. } -A layer can train its learner on its training data and store the resulting model. See the public function \code{Layer$train()} below. +A training layer can train its learner on its training data and store the resulting model. See the public function \code{Layer$train()} below. -A layer can make predictions for a new layer passed as argument to its predict function. See the public function \code{Layer$predict()} below. +A training layer can make predictions for a new layer passed as argument to its predict function. See the public function \code{Layer$predict()} below. } \seealso{ \link{Training}, \link{Lrner}, \link{TrainData}, \link{TestData} and \link{Model} diff --git a/man/createTestLayer.Rd b/man/createTestLayer.Rd index 14b37f9..b7c2744 100644 --- a/man/createTestLayer.Rd +++ b/man/createTestLayer.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/createTesting.R \name{createTestLayer} \alias{createTestLayer} -\title{Creates and store a \link{TestLayer} on the \link{Testing} object passed as argument.} +\title{createTestLayer} \usage{ createTestLayer(testing, test_layer_id, test_data) } diff --git a/man/createTesting.Rd b/man/createTesting.Rd index 9560137..b0f5f6f 100644 --- a/man/createTesting.Rd +++ b/man/createTesting.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/createTesting.R \name{createTesting} \alias{createTesting} -\title{Creates a \link{Testing} object.} +\title{createTesting} \usage{ createTesting(id, ind_col) } diff --git a/man/createTrainLayer.Rd b/man/createTrainLayer.Rd index 4e8d3e5..f00fef7 100644 --- a/man/createTrainLayer.Rd +++ b/man/createTrainLayer.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/createTraining.R \name{createTrainLayer} \alias{createTrainLayer} -\title{Creates and store a \link{TrainLayer} on the \link{Training} object passed as argument.} +\title{createTrainLayer} \usage{ createTrainLayer( training, diff --git a/man/createTrainMetaLayer.Rd b/man/createTrainMetaLayer.Rd index 8f20cee..dcbfa66 100644 --- a/man/createTrainMetaLayer.Rd +++ b/man/createTrainMetaLayer.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/createTraining.R \name{createTrainMetaLayer} \alias{createTrainMetaLayer} -\title{Creates and store a \link{TrainMetaLayer} on the \link{Training} object passed as argument.} +\title{createTrainMetaLayer} \usage{ createTrainMetaLayer( training, diff --git a/man/createTraining.Rd b/man/createTraining.Rd index 4f66b00..a64a1a7 100644 --- a/man/createTraining.Rd +++ b/man/createTraining.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/createTraining.R \name{createTraining} \alias{createTraining} -\title{Creates a \link{Training} object.} +\title{createTraining} \usage{ createTraining( id, diff --git a/man/fusemlr.Rd b/man/fusemlr.Rd index e634dd7..54053df 100644 --- a/man/fusemlr.Rd +++ b/man/fusemlr.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/createTraining.R \name{fusemlr} \alias{fusemlr} -\title{Trains the \link{Training} object passed as argument. All leaners and the meta learner are trained.} +\title{fusemlr} \usage{ fusemlr( training, diff --git a/man/predict.Training.Rd b/man/predict.Training.Rd index 319d90f..1ef2e2d 100644 --- a/man/predict.Training.Rd +++ b/man/predict.Training.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/createTraining.R \name{predict.Training} \alias{predict.Training} -\title{Computes predictions for the \link{Testing} object passed as argument.} +\title{predict.Training} \usage{ \method{predict}{Training}(object, testing, ind_subset = NULL) } diff --git a/man/upsetplot.Rd b/man/upsetplot.Rd index b9936e0..1f6544b 100644 --- a/man/upsetplot.Rd +++ b/man/upsetplot.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/createTraining.R \name{upsetplot} \alias{upsetplot} -\title{An upset plot of overlapping individuals.} +\title{upsetplot} \usage{ upsetplot(object, ...) } diff --git a/man/varSelection.Rd b/man/varSelection.Rd index 086b3bf..da37028 100644 --- a/man/varSelection.Rd +++ b/man/varSelection.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/createTraining.R \name{varSelection} \alias{varSelection} -\title{Variable selection on the current training object.} +\title{varSelection} \usage{ varSelection(training, ind_subset = NULL, verbose = TRUE) }