summaryrefslogtreecommitdiff
path: root/man/dataSlice.Rd
diff options
context:
space:
mode:
Diffstat (limited to 'man/dataSlice.Rd')
-rw-r--r--man/dataSlice.Rd13
1 files changed, 7 insertions, 6 deletions
diff --git a/man/dataSlice.Rd b/man/dataSlice.Rd
index a34e7c6..cd3af74 100644
--- a/man/dataSlice.Rd
+++ b/man/dataSlice.Rd
@@ -9,11 +9,12 @@ dataSlice(data, start = NULL, end = NULL, freq = NULL)
\arguments{
\item{data}{an object of class \code{idframe}}
-\item{start}{the start index}
+\item{start}{the start time of the period of interest}
-\item{end}{the end index}
+\item{end}{the end time of the period of interes}
-\item{freq}{the new sampling frequency}
+\item{freq}{fraction of the original frequency at which the series
+to be sampled.}
}
\value{
an idframe object
@@ -25,15 +26,15 @@ and \code{end}. If a frequency is specified, the series is then re-sampled at t
new frequency.
}
\details{
-The dataSlice function extends the \code{\link[stats]{window}} function for idframe
-objects
+The dataSlice function extends the \code{\link[stats]{window}}
+function for idframe objects
}
\examples{
data(cstr)
cstrsub <- dataSlice(cstr,start=200,end=400) # extract between indices 200 and 400
cstrTrain <- dataSlice(cstr,end=4500) # extract upto index 4500
cstrTest <- dataSlice(cstr,start=6501) # extract from index 6501 till the end
-cstr_new <- dataSlice(cstr,freq=3) # resample data at thrice the frequency
+cstr_new <- dataSlice(cstr,freq=0.5) # resample data at half the original frequency
}
\seealso{
\code{\link[stats]{window}}