\name{TimeSeriesSubsettings}


\alias{TimeSeriesSubsettings}


\alias{[.timeSeries} 
\alias{[<-.timeSeries}
\alias{cut.timeSeries} 
\alias{window.timeSeries}
\alias{head.timeSeries}
\alias{tail.timeSeries}
\alias{outlier.timeSeries}


\title{Subsettig Time Series}


\description{
  
    Subset a 'timeSeries' objects due to different aspects.         
    \cr
  
    \tabular{ll}{
    \code{[} \tab "[" method for a 'timeSeries' object, \cr
    \code{[<-} \tab "[<-" method to assign value for a subset of a 'timeSeries' object, \cr
    \code{window} \tab Windows a piece from a 'timeSeries' object, \cr
    \code{cut} \tab A no longer used synonyme for window, \cr
    \code{head} \tab Returns the head of a 'timeSeries' object, \cr
    \code{tail} \tab Returns the tail of a 'timeSeries' object, \cr
    \code{outliers} \tab Removes outliers from a 'timeSeries' object. }
  
}


\usage{

\method{[}{timeSeries}(x, i, j)
\method{[}{timeSeries}(x, i, j) <- value

\method{window}{timeSeries}(x, from, to, \dots)

\method{head}{timeSeries}(x, n = 6, recordIDs = FALSE, \dots)
\method{tail}{timeSeries}(x, n = 6, recordIDs = FALSE, \dots)

\method{outlier}{timeSeries}(x, sd = 10, complement = TRUE, \dots)

\method{cut}{timeSeries}(x, from, to, \dots)
}


\arguments{
  
    \item{complement}{
        [outlierSeries] - \cr
        a logical flag, should the outler series
        or its complement be returns, by default \code{TRUE}
        which returns the series free of outliers.
        }
     \item{from, to}{
        starting date and end date, \code{to} must be after \code{from}.
        }
     \item{i, j}{
        ["["] - \cr 
        index arguments used for subsettings.
        }        
     \item{n}{
        [head][tail] - \cr
        an integer specifying the number of lines to be returned. 
        By default \code{n=6}.
        }
     \item{recordIDs}{
        [head][tail] - \cr
        a logical value. Should the \code{recordIDs} returned together
        with the data matrix and time series positions?
        }
     \item{sd}{
        [outlierSeries] - \cr
        a numeric value of standard deviations, e.g. 10
        means that values larger or smaller tahn ten 
        times the standard deviation will be removed from
        the series.
        }
      \item{value}{
        a numeric value to use as a replacement. It will be repeated a
        whole number of times if necessary. 
     }
     \item{x}{
        an object of class \code{timeSeries}.
        }
     \item{\dots}{
        arguments passed to other methods.
        }
        
}

        
\value{

    all functions return an object of class \code{timeSeries}.
  
}


\examples{
## data - 
   # Create an artificial timeSeries object:
   myFinCenter <<- "GMT"
   charvec = timeCalendar()
   set.seed(4711)
   data = matrix(exp(cumsum(rnorm(12, sd = 0.1))))
   tS = timeSeries(data, charvec, units = "tS")
   tS
   
## "[" - 
   tS[1:3, ]
       
## head - 
   head(tS)
}


\keyword{chron}