summaryrefslogtreecommitdiff
path: root/man/detrend.Rd
diff options
context:
space:
mode:
Diffstat (limited to 'man/detrend.Rd')
-rw-r--r--man/detrend.Rd9
1 files changed, 5 insertions, 4 deletions
diff --git a/man/detrend.Rd b/man/detrend.Rd
index 3f4faa4..b10565d 100644
--- a/man/detrend.Rd
+++ b/man/detrend.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/preprocess.R
\name{detrend}
\alias{detrend}
@@ -16,9 +16,9 @@ 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
+ \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
+ \code{input_trend} \tab \code{list} containing trend fits for each input
variable
}
}
@@ -27,11 +27,12 @@ Removes the offsets or linear trends in each of the input and output matrices.
}
\examples{
data(cstr)
-fit <- detrend(cstr,type="linear") # remove linear trends
+fit <- detrend(cstr,type="linear") # remove linear trends
Zdetrend <- predict(fit) # get the detrended data
demean <- detrend(cstr) # remove offsets
Zcent <- predict(demean) # get the centered data
+
}
\seealso{
\code{\link{predict.detrend}}, \code{\link[stats]{lm}}