pcts (version 0.15.8)

PartialCycle-class: Class PartialCycle

Description

Class PartialCycle

Objects from the Class

Objects can be created by calls of the form new("PartialCycle", ...).

Partial cycles are often created implicitly when subsetting time series using window() with argument seasons, see the examples.

Slots

orig:

the parent class of the partial cycle, an object inheriting from class "BasicCycle".

subindex:

an integer vector specifying the seasons to include in the partial cycle.

Extends

Class "BasicCycle", directly.

Methods

allSeasons

signature(x = "PartialCycle", abb = "logical"): ...

allSeasons

signature(x = "PartialCycle", abb = "missing"): ...

nSeasons

signature(object = "PartialCycle"): ...

unitCycle

signature(x = "PartialCycle"): ...

unitSeason

signature(x = "PartialCycle"): ...

show

signature(object = "PartialCycle"): ...

See Also

BuiltinCycle

Examples

dwc <- new("DayWeekCycle")
dwc
allSeasons(dwc)

## a five day week cycle
dwc5 <- new("PartialCycle", orig = dwc, subindex = 1:5)
dwc5
allSeasons(dwc5)

weekend <- new("PartialCycle", orig = dwc, subindex = 6:7)
weekend
allSeasons(weekend)

ap <- pcts(AirPassengers)

## take data for the summer months (in Northern hemisphere)
ap7to9 <- window(ap, seasons = 7:9)
## the above implicitly creates a partial cycle
ap7to9
allSeasons(ap7to9)