diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/dataPartition.Rd | 21 | ||||
| -rw-r--r-- | man/dataSlice.Rd | 17 |
2 files changed, 38 insertions, 0 deletions
diff --git a/man/dataPartition.Rd b/man/dataPartition.Rd new file mode 100644 index 0000000..501ace2 --- /dev/null +++ b/man/dataPartition.Rd @@ -0,0 +1,21 @@ +% Generated by roxygen2 (4.1.0): do not edit by hand +% Please edit documentation in R/partition.R +\name{dataPartition} +\alias{dataPartition} +\title{Split data into training and validation sets} +\usage{ +dataPartition(object, p = 0.6) +} +\arguments{ +\item{object}{an object of class \code{idframe}} + +\item{p}{the percentage of the data that goes to training (Default : \code{0.6})} +} +\value{ +list containing estimation and validation idframe objects +} +\description{ +The function splits the data into training and validation sets and returns them bundled +as a list. The size of the sets are determined by the parameter \code{p}. +} + diff --git a/man/dataSlice.Rd b/man/dataSlice.Rd new file mode 100644 index 0000000..2489cc3 --- /dev/null +++ b/man/dataSlice.Rd @@ -0,0 +1,17 @@ +% Generated by roxygen2 (4.1.0): do not edit by hand +% Please edit documentation in R/partition.R +\name{dataSlice} +\alias{dataSlice} +\title{Subset an idframe object} +\usage{ +dataSlice(object, indices) +} +\arguments{ +\item{object}{an object of class \code{idframe}} + +\item{indices}{the indices that need to be subsetted} +} +\description{ +Subsetting method for objects of class \code{idframe} +} + |