From bff582e5c13b775d7d2dda17015ed8e2990c3f6d Mon Sep 17 00:00:00 2001 From: unknown Date: Thu, 2 Apr 2015 15:59:09 +0530 Subject: updated documentation for the detrend function --- man/detrend.idframe.Rd | 32 -------------------------------- 1 file changed, 32 deletions(-) delete mode 100644 man/detrend.idframe.Rd (limited to 'man/detrend.idframe.Rd') diff --git a/man/detrend.idframe.Rd b/man/detrend.idframe.Rd deleted file mode 100644 index 973bd08..0000000 --- a/man/detrend.idframe.Rd +++ /dev/null @@ -1,32 +0,0 @@ -% Generated by roxygen2 (4.1.0): do not edit by hand -% Please edit documentation in R/detrend.R -\name{detrend.idframe} -\alias{detrend.idframe} -\title{Remove linear trends} -\usage{ -detrend.idframe(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 detrended variables \cr - \code{output.trend} \tab \code{list} containing trend fits for each output variable \cr - \code{input.trend} \tab \code{list} containing trend fits for each input variable - } -} -\description{ -Removes the linear trends in the input and output matrices. -} -\examples{ -data(cstr) -fit <- detrend.idframe(cstr) -cstr_detrend <- predict(fit) -} -\seealso{ -\code{\link{predict.detrend.idframe}}, \code{\link[stats]{lm}} -} - -- cgit