aggregate-methods {surveillance}R Documentation

Aggregate an "sts" Object Over Time or Across Units

Description

Method to aggregate the matrix slots of an sts object. Either the time series is aggregated so a new sampling frequency of nfreq units per time slot is obtained (i.e as in aggregate.ts) or the aggregation is over all ncol units.

Note: The function is not 100% consistent with what the generic function aggregate does.

Methods

x = "sts", by="time", nfreq="all",...
x

an object of class sts

by

a string being either "time" or "unit"

nfreq

new sampling frequency if by=="time". If nfreq=="all" then all time instances are summed.

...

not used

returns an object of class sts

Warning

Aggregation by unit sets the upperbound slot to NA and the map slot is left as-is, but the object cannot be plotted by unit any longer. The populationFrac slot is aggregated just like the observed slot and population fractions are recomputed. This might not be intended, especially for aggregation over time.

See Also

aggregate

Examples

  data("ha.sts")
  dim(ha.sts)
  dim(aggregate(ha.sts,by="unit"))
  dim(aggregate(ha.sts,nfreq=13))

[Package surveillance version 1.16.1 Index]