diff --git a/R/machinelearning.R b/R/machinelearning.R index 0b99761..f73f7f1 100644 --- a/R/machinelearning.R +++ b/R/machinelearning.R @@ -155,11 +155,10 @@ parametersEqual <- function(recipient, donor) { #' OrganiseCategoricalPredictors #' -#' Organize information about categorical predictors in the model +#' Organize information about categorical predictors in the model. #' @param input.model The machine learning model. #' @param all.combo.boxes The selection of predictor values. #' @export -#' @noRd OrganiseCategoricalPredictors <- function(input.model, all.combo.boxes) { estimation.data.template <- input.model$estimation.data.template all.variable.names <- names(estimation.data.template) @@ -219,7 +218,6 @@ OrganiseCategoricalPredictors <- function(input.model, all.combo.boxes) { #' @param is.numeric A logical value indicating if the outcome is numeric. #' @importFrom utils getS3method #' @export -#' @noRd PredictOutcome <- function(input.model, DF, is.numeric) { vector.or.class <- if (is.numeric) "vector" else "class" is.cart <- inherits(input.model, "CART") @@ -255,7 +253,6 @@ PredictOutcome <- function(input.model, DF, is.numeric) { #' @param DF The data frame containing the predictor values. #' @importFrom utils getS3method #' @export -#' @noRd PredictProbabilities <- function(input.model, DF) { model.classes <- class(input.model) if ("SupportVectorMachine" %in% model.classes) { diff --git a/man/OrganiseCategoricalPredictors.Rd b/man/OrganiseCategoricalPredictors.Rd new file mode 100644 index 0000000..f9fe453 --- /dev/null +++ b/man/OrganiseCategoricalPredictors.Rd @@ -0,0 +1,16 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/machinelearning.R +\name{OrganiseCategoricalPredictors} +\alias{OrganiseCategoricalPredictors} +\title{OrganiseCategoricalPredictors} +\usage{ +OrganiseCategoricalPredictors(input.model, all.combo.boxes) +} +\arguments{ +\item{input.model}{The machine learning model.} + +\item{all.combo.boxes}{The selection of predictor values.} +} +\description{ +Organize information about categorical predictors in the model. +} diff --git a/man/PredictOutcome.Rd b/man/PredictOutcome.Rd new file mode 100644 index 0000000..6cc45ec --- /dev/null +++ b/man/PredictOutcome.Rd @@ -0,0 +1,18 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/machinelearning.R +\name{PredictOutcome} +\alias{PredictOutcome} +\title{PredictOutcome} +\usage{ +PredictOutcome(input.model, DF, is.numeric) +} +\arguments{ +\item{input.model}{The machine learning model.} + +\item{DF}{The data frame containing the predictor values.} + +\item{is.numeric}{A logical value indicating if the outcome is numeric.} +} +\description{ +Predict the outcome for a simulator for a machine learning model. +} diff --git a/man/PredictProbabilities.Rd b/man/PredictProbabilities.Rd new file mode 100644 index 0000000..b61e946 --- /dev/null +++ b/man/PredictProbabilities.Rd @@ -0,0 +1,16 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/machinelearning.R +\name{PredictProbabilities} +\alias{PredictProbabilities} +\title{PredictProbabilities} +\usage{ +PredictProbabilities(input.model, DF) +} +\arguments{ +\item{input.model}{The machine learning model.} + +\item{DF}{The data frame containing the predictor values.} +} +\description{ +Predict the probabilities for a simulator for a machine learning model. +}