diff options
| author | Suraj Yerramilli | 2015-02-11 20:56:41 +0530 |
|---|---|---|
| committer | Suraj Yerramilli | 2015-02-11 20:56:41 +0530 |
| commit | 6f0ea5bf4c83111ef469886d21a1612bd394a2eb (patch) | |
| tree | 46422dc78dbe36ccefc714c8ca8282056d834179 /man/detrend.idframe.Rd | |
| parent | a1912915b20ed0e475ce69495e2b6292b57bea98 (diff) | |
| download | SysID-R-code-6f0ea5bf4c83111ef469886d21a1612bd394a2eb.tar.gz SysID-R-code-6f0ea5bf4c83111ef469886d21a1612bd394a2eb.tar.bz2 SysID-R-code-6f0ea5bf4c83111ef469886d21a1612bd394a2eb.zip | |
added documentation
Diffstat (limited to 'man/detrend.idframe.Rd')
| -rw-r--r-- | man/detrend.idframe.Rd | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/man/detrend.idframe.Rd b/man/detrend.idframe.Rd new file mode 100644 index 0000000..9461363 --- /dev/null +++ b/man/detrend.idframe.Rd @@ -0,0 +1,32 @@ +% 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 + \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 function from the input and output matrices. +} +\examples{ +data(cstr) +fit <- detrend(cstr) +cstr_detrend <- predict(fit) +} +\seealso{ +\code{\link{predict.detrend.idframe}}, \code{\link[stats]{lm}} +} + |