pcts (version 0.15.8)

pcts_exdata: Periodic time series objects for examples

Description

Periodic time series objects for examples and tests. These objects are from classes defined in package “pcts” and as a consequence are not suitable for access with data().

Usage

pcts_exdata(x, envir = parent.frame())

Value

if x is NA, the names of the available objects. Otherwise the function is called for the side effect of creating objects in envir and the return value (the names of the created objects) is usually discarded.

Arguments

x

a character vector giving the names of objects. If missing, all available objects will be created. Can also be NA. In that case no objects are created and the names of all available objects are returned.

envir

environment where the objects are put, the default is the environment of the caller.

Details

The requested objects are created and put in envir. Its default is the environment of the caller, which should be sufficient in most use cases.

The following objects are currently available: paste0("\\code{", pcts::pcts_exdata(NA), "}", collapse = ", ").

See Also

dataFranses1996

Examples

## the objects are created with something like:
ap <- pcts(AirPassengers)
ap7to9 <- window(ap, seasons = 7:9)

pcfr <- pcts(dataFranses1996)
pcfr2to4 <- pcfr[2:4]