File: stats-aggregate.Rd

package info (click to toggle)
r-cran-timeseries 4041.111-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,704 kB
  • sloc: makefile: 14
file content (86 lines) | stat: -rw-r--r-- 1,784 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
\name{aggregate-methods}
\alias{aggregate-methods}

\docType{methods}

\alias{aggregate}
\alias{aggregate.timeSeries}
\alias{aggregate,timeSeries-method}


\title{Aggregate time series}

\description{
    
  Aggregate a \code{"timeSeries"} object over general periods.  
    
}

\usage{
\S4method{aggregate}{timeSeries}(x, by, FUN, \dots)
}

\arguments{
  
  \item{x}{
    an object of class \code{"timeSeries"}.
  } 
  \item{by}{
    a sequence of \code{"timeDate"} objects denoting the aggregation
    periods, see section \sQuote{Details}.
  }
  \item{FUN}{
    the function to be applied.
  }               
  \item{\dots}{
    arguments passed to other methods.
  }
}

\details{

  \code{aggregate} aggregates \code{x} by applying \code{FUN} on the
  values of the time series in each of the aggregation periods,
  specified by argument \code{by}.

  Argument \code{by} should be of the same class as
  \code{time(x)}. \code{by} is sorted and duplicated values are removed
  from it. Each pair of consecutive values in \code{by} then determines
  a period over which to apply the aggregation function \code{FUN}, see
  \code{\link[base]{findInterval}}.

}

\value{
  an object of class \code{"timeSeries"}
}

\seealso{
  \code{\link{apply}},
  \code{\link{align}}
}

\examples{
## Load Microsoft Data Set -
   x <- MSFT

## Aggregate by Weeks - 
   by <- timeSequence(from = start(x),  to = end(x), by = "week")
   aggregate(x, by, mean)

## Aggregate to Last Friday of Month -
   by <- unique(timeLastNdayInMonth(time(x), 5))
   X <- aggregate(x, by, mean)
   X
   dayOfWeek(time(X))
   isMonthly(X)

## Aggregate to Last Day of Quarter -
   by <- unique(timeLastDayInQuarter(time(x)))
   X <-  aggregate(x, by, mean)
   X
   isQuarterly(X)
}

\keyword{methods}
\keyword{chron}