period: Subset data set/time series to specific periodically data

View source: R/deepTimeSeries.r

periodR Documentation

Subset data set/time series to specific periodically data

Description

Subset data set/time series to specific periodically data

Usage

period(
  dataset,
  column = 1L,
  type = c("seq", "weekday", "monthday", "week", "month", "quarter", "year", "season"),
  ...
)

Arguments

dataset

A data set or time series, usually a data frame.

column

The name or index of a periodic column.

type

Different subsetting types
seq A sequence specified thru start index and increment passed in ... as numbers.
weekday Certain days of week are extracted from the data set whereby the days are passed in ... as strings.
monthday Certain days of month are extracted from the data set whereby the days are passed in ... as numbers.
week Certain weeks are extracted from the data set whereby the weeks are passed in ... as numbers.
month Certain months are extracted from the data set whereby the months are passed in ... as strings.
quarter Certain quarters are extracted from the data set whereby the quarters are passed in ... as numbers.
year Certain years are extracted from the data set whereby the years are passed in ... as numbers.
season Certain seasons are extracted from the data set whereby the seasons are passed in ... as strings.

...

Arguments dependent from the type.

Value

A subset of dataset with periodically specified data.

See Also

Other Time Series: diff_log(), diff_percentage(), diffinv_log(), diffinv_percentage(), diffinv_simple(), get_season(), invert_differencing(), lags(), partition(), stationary()


stschn/deepANN documentation built on June 25, 2024, 7:27 a.m.