Added documentation for the demean function

4 files changed, 65 insertions, 2 deletions

diff --git a/man/demean.Rd b/man/demean.Rd
new file mode 100644
index 0000000..278f46a
--- /dev/null
+++ b/man/demean.Rd
@@ -0,0 +1,32 @@
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/demean.R
+\name{demean}
+\alias{demean}
+\title{Mean-Center the data}
+\usage{
+demean(data)
+}
+\arguments{
+\item{data}{an object of class \code{idframe}}
+}
+\value{
+A list containing the following elements
+
+\tabular{ll}{
+   \code{fitted.values} \tab \code{idframe} object with mean-centered variables \cr
+   \code{output.mean} \tab \code{vector} containing means for each output variable \cr
+   \code{input.mean} \tab \code{vector} containing trend fits for each input variable
+ }
+}
+\description{
+Mean Centers the input and output matrices.
+}
+\examples{
+data(cstr)
+fit.mean <- demean(cstr)
+cstr_detrend <- predict(fit.mean)
+}
+\seealso{
+\code{\link{predict.demean}}, \code{\link[stats]{colMeans}}
+}
+
diff --git a/man/detrend.idframe.Rd b/man/detrend.idframe.Rd
index b9facb7..973bd08 100644
--- a/man/detrend.idframe.Rd
+++ b/man/detrend.idframe.Rd
@@ -19,7 +19,7 @@ A list containing the following elements
  }
 }
 \description{
-Removes the linear function from the input and output matrices.
+Removes the linear trends in the input and output matrices.
 }
 \examples{
 data(cstr)
diff --git a/man/predict.demean.Rd b/man/predict.demean.Rd
new file mode 100644
index 0000000..0fd798b
--- /dev/null
+++ b/man/predict.demean.Rd
@@ -0,0 +1,31 @@
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/demean.R
+\name{predict.demean}
+\alias{predict.demean}
+\title{Predict the centered values}
+\usage{
+\method{predict}{demean}(object, newdata = NULL, ...)
+}
+\arguments{
+\item{object}{an object of class \code{idframe}}
+
+\item{newdata}{An optional idframe object in which to look for variables with which
+to predict. If ommited, the original idframe object is used}
+}
+\value{
+an \code{idframe} object
+}
+\description{
+Center an \code{idframe} object based on the training center means
+}
+\examples{
+## Examples for train and test sets
+data(cstr)
+splitList <- dataPartition(cstr,p=0.6)
+train <- splitList$estimation # training set
+test <- splitList$validation # testing set
+fit.mean <- demean(train)
+train_demean <- predict(fit.mean)
+test_demean <- predict(fit,newdata=test)
+}
+
diff --git a/man/predict.detrend.idframe.Rd b/man/predict.detrend.idframe.Rd
index 35ec2d3..938cd31 100644
--- a/man/predict.detrend.idframe.Rd
+++ b/man/predict.detrend.idframe.Rd
@@ -9,7 +9,7 @@
 \arguments{
 \item{object}{an object of class \code{idframe}}
 
-\item{newdata}{An optional idframe object in whic to look for variables with which
+\item{newdata}{An optional idframe object in which to look for variables with which
 to predict. If ommited, the original detrended idframe object is used}
 }
 \value{