\name{time}


\title{timeSeries, Positions}


\alias{time}
\alias{seriesPositions}
\alias{newPositions<-}

\alias{time.timeSeries}
\alias{sample.timeSeries}
\alias{sort.timeSeries}
\alias{rev.timeSeries}

\alias{start.timeSeries}
\alias{end.timeSeries}


\description{
    
    Functions and methods extracting and modifying positions 
    of 'timeSeries' objects.       
    \cr
    
    The functions and methods for the Generation of 'timeSeries' Objects are:         

    \tabular{ll}{   
    \code{seriesPositions} \tab Extracts positions slot from a 'timeSeries', \cr
    \code{newPositions<-} \tab Modifies positions of a 'timeSeries' object, \cr
    \code{time.timeSeries} \tab Extracts time positions from a 'timeSeries', \cr
    \code{sample.timeSeries} \tab Resamples a 'timeSeries' object in time, \cr
    \code{sort.timeSeries} \tab Sorts reverts a 'timeSeries' object in time, \cr
    \code{rev.timeSeries} \tab Reverts a 'timeSeries' object in time, \cr 
    \code{start.timeSeries} \tab Extracts start date of a 'timeSeries' object, \cr 
    \code{end.timeSeries} \tab Extracts end date of a 'timeSeries' object. }
        
}


\usage{
seriesPositions(object)
newPositions(object) <- value

\method{time}{timeSeries}(x, \dots)

\method{start}{timeSeries}(x, \dots)
\method{end}{timeSeries}(x, \dots)

\method{sample}{timeSeries}(x, \dots)
\method{sort}{timeSeries}(x, \dots)
\method{rev}{timeSeries}(x)
}


\arguments{

    \item{method}{ 
        [alignDailySeries] - \cr
        the method to be used for the alignment. A character string, one
        of \code{"before"}, use the data from the row whose position is
        just before the unmatched position, or \code{"after"}, use the 
        data from the row whose position is just after the unmatched 
        position, or \code{"linear"}, interpolate linearly between 
        \code{"before"} and \code{"after"}. 
        }      
    \item{object}{
        [is][seriesData][seriesPositions][summary] -    
        an object of class \code{timeSeries}.
        }
    \item{value}{
        a valid value for that component of \code{newPositions(x)}, i.e.
        an object of class \code{"timeDate"} with appropriate length.
        }
    \item{x}{
        [as] - \cr   
        a \code{matrix} type object to be converted.\cr
        [as.vector][as.matrix][as.data.frame] -\cr
        [applySeries] - \cr
        [cut][end][mergeSeries][plot][print][rev][start] - \cr
        an object of class \code{timeSeries}.
        } 
    \item{\dots}{
        arguments passed to other methods.
        }
       
}


\value{

    \code{timeSeries}\cr
    \code{read.timeSeries}\cr
    \code{as.timeSeries}
    \cr
    return a S4 object of class \code{timeSeries}.
    \cr
    
    \code{seriesData}\cr
    \code{seriesPositions}
    \cr
    extract the \code{@Data} and \code{@position} slots from a 
    \code{timeSeries} object. Thus, \code{seriesData} returns an 
    object of class \code{matrix}, and \code{seriesPositions}
    returns an object of class \code{timeDate}.
    \cr
    
    \code{is.timeSeries}
    \cr
    returns \code{TRUE} or \code{FALSE} depending on whether its
    argument is of \code{timeSeries} type or not.
    \cr
        
    \code{aggregateSeries}\cr
    \code{applySeries}\cr
    \code{cutSeries}\cr
    \code{mergeSeries}\cr
    \code{returnSeries}\cr
    \code{revSeries}
    \cr
    return a S4 object of class \code{timeSeries}.
    \cr
    
    \code{end, start}
    \cr
    return a S4 object of class \code{timedate}. These are the 
    start and end dates of a \code{timeSeries} object.
    \cr
    
    \code{as.vector}\cr
    \code{as.matrix}\cr
    \code{as.data.frame}
    \cr
    these are methods which convert a S4 object of class \code{timeSeries}
    either to a vector, a matrix or to a data frame.
    \cr
    
    \code{plot}\cr
    \code{lines}\cr
    \code{points}\cr
    \code{print}
    \cr
    plot and print methods for an object of class \code{timeSeries}.
    Note that the plot function requires the packages \code{its} and
    \code{Hmisc}.
    \cr
        
}


\examples{   
## Create dummy timeSeries:     
   X = timeSeries(matrix(rnorm(24), 12), timeCalendar())
   
## seriesPositions -
   seriesPositions(X)
}


\keyword{chron}