1\name{TimeSeriesSubsettings}
2
3
4\alias{TimeSeriesSubsettings}
5
6\alias{[,timeSeries,ANY,index_timeSeries-method}
7\alias{[,timeSeries,character,character-method}
8\alias{[,timeSeries,character,index_timeSeries-method}
9\alias{[,timeSeries,character,missing-method}
10\alias{[,timeSeries,index_timeSeries,character-method}
11\alias{[,timeSeries,index_timeSeries,index_timeSeries-method}
12\alias{[,timeSeries,index_timeSeries,missing-method}
13\alias{[,timeSeries,matrix,index_timeSeries-method}
14\alias{[,timeSeries,matrix,missing-method}
15\alias{[,timeSeries,missing,character-method}
16\alias{[,timeSeries,missing,index_timeSeries-method}
17\alias{[,timeSeries,missing,missing-method}
18\alias{[,timeSeries,timeDate,character-method}
19\alias{[,timeSeries,timeDate,index_timeSeries-method}
20\alias{[,timeSeries,timeDate,missing-method}
21\alias{[,timeSeries,timeSeries,index_timeSeries-method}
22\alias{[,timeSeries,timeSeries,missing-method}
23
24\alias{[,timeSeries,time_timeSeries,ANY-method}
25\alias{[,timeSeries,time_timeSeries,character-method}
26\alias{[,timeSeries,time_timeSeries,index_timeSeries-method}
27\alias{[,timeSeries,time_timeSeries,missing-method}
28
29\alias{$,timeSeries-method}
30
31\alias{[<-,timeSeries,timeDate,index_timeSeries-method}
32\alias{[<-,timeSeries,timeDate,missing-method}
33\alias{[<-,timeSeries,timeSeries,index_timeSeries-method}
34\alias{[<-,timeSeries,timeSeries,missing-method}
35\alias{[<-,timeSeries,character,character-method}
36\alias{[<-,timeSeries,character,index_timeSeries-method}
37\alias{[<-,timeSeries,character,missing-method}
38\alias{[<-,timeSeries,index_timeSeries,character-method}
39\alias{[<-,timeSeries,matrix,character-method}
40\alias{[<-,timeSeries,timeDate,character-method}
41\alias{[<-,timeSeries,timeSeries,character-method}
42
43\alias{[<-,timeSeries,character,ANY-method}
44\alias{[<-,timeSeries,timeDate,ANY-method}
45
46\alias{$<-,timeSeries,ANY-method}
47\alias{$<-,timeSeries,factor-method}
48\alias{$<-,timeSeries,numeric-method}
49
50\alias{$<-,timeSeries,ANY,ANY-method}
51\alias{$<-,timeSeries,ANY,factor-method}
52\alias{$<-,timeSeries,ANY,numeric-method}
53
54\alias{window,timeSeries-method}
55\alias{cut,timeSeries-method}
56\alias{head,timeSeries-method}
57\alias{tail,timeSeries-method}
58
59\alias{window.timeSeries}
60\alias{cut.timeSeries}
61\alias{head.timeSeries}
62\alias{tail.timeSeries}
63
64\alias{outlier}
65\alias{outlier,timeSeries-method}
66\alias{outlier,ANY-method}
67
68\title{Subsettig Time Series}
69
70
71\description{
72
73    Subset a 'timeSeries' objects due to different aspects.
74    \cr
75
76    \tabular{ll}{
77    \code{[} \tab "[" method for a 'timeSeries' object, \cr
78    \code{[<-} \tab "[<-" method to assign value for a subset of a 'timeSeries' object, \cr
79    \code{window} \tab Windows a piece from a 'timeSeries' object, \cr
80    \code{cut} \tab A no longer used synonyme for window, \cr
81    \code{head} \tab Returns the head of a 'timeSeries' object, \cr
82    \code{tail} \tab Returns the tail of a 'timeSeries' object, \cr
83    \code{outliers} \tab Removes outliers from a 'timeSeries' object. }
84
85}
86
87
88\usage{
89
90% \method{[}{timeSeries}(x, i, j, drop)
91% \method{[}{timeSeries}(x, i, j) <- value
92
93\S4method{window}{timeSeries}(x, start, end, \dots)
94
95\S4method{head}{timeSeries}(x, n = 6, recordIDs = FALSE, \dots)
96\S4method{tail}{timeSeries}(x, n = 6, recordIDs = FALSE, \dots)
97
98\S4method{outlier}{timeSeries}(x, sd = 3, complement = TRUE, \dots)
99
100\S4method{cut}{timeSeries}(x, from, to, \dots)
101}
102
103
104\arguments{
105
106    \item{complement}{
107        [outlierSeries] - \cr
108        a logical flag, should the outler series
109        or its complement be returns, by default \code{TRUE}
110        which returns the series free of outliers.
111        }
112     \item{from, to}{
113        starting date and end date, \code{to} must be after \code{from}.
114        }
115     \item{start, end}{
116        starting date and end date, \code{end} must be after \code{start}.
117        }
118%      \item{i, j}{
119%         ["["] - \cr
120%         index arguments used for subsettings.
121%         }
122     \item{n}{
123        [head][tail] - \cr
124        an integer specifying the number of lines to be returned.
125        By default \code{n=6}.
126        }
127     \item{recordIDs}{
128        [head][tail] - \cr
129        a logical value. Should the \code{recordIDs} returned together
130        with the data matrix and time series positions?
131        }
132     \item{sd}{
133        [outlierSeries] - \cr
134        a numeric value of standard deviations, e.g. 10
135        means that values larger or smaller tahn ten
136        times the standard deviation will be removed from
137        the series.
138        }
139%       \item{value}{
140%         a numeric value to use as a replacement. It will be repeated a
141%         whole number of times if necessary.
142%      }
143     \item{x}{
144        an object of class \code{timeSeries}.
145        }
146     \item{\dots}{
147        arguments passed to other methods.
148        }
149
150}
151
152
153\value{
154
155    All functions return an object of class 'timeSeries'.
156
157}
158
159
160\examples{
161## Create an Artificial timeSeries Object -
162   setRmetricsOptions(myFinCenter = "GMT")
163   charvec <- timeCalendar()
164   set.seed(4711)
165   data <- matrix(exp(cumsum(rnorm(12, sd = 0.1))))
166   tS <- timeSeries(data, charvec, units = "tS")
167   tS
168
169## Subset Series by Counts "[" -
170   tS[1:3, ]
171
172## Subset the Head of the Series -
173   head(tS, 6)
174}
175
176
177\keyword{chron}
178
179