summaryrefslogtreecommitdiff
path: root/man/detrend.idframe.Rd
blob: 973bd08d170c65903e19d1af452f19468bcaa10f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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 \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}}
}