validate_decomposition: Map a Dataset to an STL Decomposition Using Data Up to a...

In jesse-smith/covidModel: COVID-19 Modeling Tools for Shelby County Health Department

Description

validate_decomposition() creates a sample decomposition and errors from a dataset, a reference decomposition, and decomposition parameters. It is designed to be used as a mapping function passed to map() within cv_decomposition().

Usage

validate_decomposition(.i, .data, .ref, period, trend)

Arguments

.i	The index of the sample; all data up to this point will be used
.data	The data to sample
.ref	A reference decomposition used to calculate errors
period	The length of time to use in seasonal decomposition; can be a time-based definition (e.g. "1 week") or an integer number of days. If NULL or "auto", period is set automatically using the tunable heuristics in the timetk package.
trend	The length of time to use in trend decomposition; can be a time-based definition (e.g. "1 month") or an integer number of days. If NULL or "auto", trend is set automatically using the tunable heuristics in the timetk package.

Value

A tibble containing the time index of the data, as well as columns sample (an indicator of the sample to which the data belongs), horizon, observed, season, trend, remainder, season_error, trend_error, and remainder_error

See Also

cv_decomposition()

jesse-smith/covidModel documentation built on Feb. 21, 2022, 3:23 p.m.