diff options
author | Suraj Yerramilli | 2015-06-06 17:22:44 +0530 |
---|---|---|
committer | Suraj Yerramilli | 2015-06-06 17:22:44 +0530 |
commit | 88a8afc6df57bf525ce1978dc02b9fb2711d4595 (patch) | |
tree | fa05b39424f1e68e0c8e0f82813391738ffbc625 /man | |
parent | ad083116e708036118d1a7bd3b6b448d4d6fae94 (diff) | |
download | SysID-R-code-88a8afc6df57bf525ce1978dc02b9fb2711d4595.tar.gz SysID-R-code-88a8afc6df57bf525ce1978dc02b9fb2711d4595.tar.bz2 SysID-R-code-88a8afc6df57bf525ce1978dc02b9fb2711d4595.zip |
Updating documentation of the preprocessing routines
Diffstat (limited to 'man')
-rw-r--r-- | man/dataSlice.Rd | 6 | ||||
-rw-r--r-- | man/detrend.Rd | 6 |
2 files changed, 6 insertions, 6 deletions
diff --git a/man/dataSlice.Rd b/man/dataSlice.Rd index 9fd571e..a34e7c6 100644 --- a/man/dataSlice.Rd +++ b/man/dataSlice.Rd @@ -1,8 +1,8 @@ % Generated by roxygen2 (4.1.1): do not edit by hand -% Please edit documentation in R/partition.R +% Please edit documentation in R/preprocess.R \name{dataSlice} \alias{dataSlice} -\title{Subset an idframe data} +\title{Subset or Resample idframe data} \usage{ dataSlice(data, start = NULL, end = NULL, freq = NULL) } @@ -19,7 +19,7 @@ dataSlice(data, start = NULL, end = NULL, freq = NULL) an idframe object } \description{ -\code{dataSlice} is a Subsetting method for objects of class \code{idframe}. It +\code{dataSlice} is a subsetting method for objects of class \code{idframe}. It extracts the subset of the object \code{data} observed between indices \code{start} and \code{end}. If a frequency is specified, the series is then re-sampled at the new frequency. diff --git a/man/detrend.Rd b/man/detrend.Rd index 2121ba1..f567247 100644 --- a/man/detrend.Rd +++ b/man/detrend.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/preprocess.R \name{detrend} \alias{detrend} -\title{Remove linear trends} +\title{Remove offsets and linear trends} \usage{ detrend(data, type = c("constant", "linear")[2]) } @@ -23,14 +23,14 @@ A list containing the following elements } } \description{ -Removes the mean value or linear trends in each of the input and output matrices. +Removes the offsets or linear trends in each of the input and output matrices. } \examples{ data(cstr) fit <- detrend(cstr) # remove linear trends Zdetrend <- predict(fit) # get the detrended data -demean <- detrend(cstr,type="constant") # remove mean values +demean <- detrend(cstr,type="constant") # remove offsets Zcent <- predict(demean) # get the centered data } \seealso{ |