`R/stats-decompose-tidiers.R`

`augment.stl.Rd`

Augment accepts a model object and a dataset and adds
information about each observation in the dataset. Most commonly, this
includes predicted values in the `.fitted`

column, residuals in the
`.resid`

column, and standard errors for the fitted values in a `.se.fit`

column. New columns always begin with a `.`

prefix to avoid overwriting
columns in the original dataset.

Users may pass data to augment via either the `data`

argument or the
`newdata`

argument. If the user passes data to the `data`

argument,
it **must** be exactly the data that was used to fit the model
object. Pass datasets to `newdata`

to augment data that was not used
during model fitting. This still requires that all columns used to fit
the model are present.

Augment will often behavior different depending on whether `data`

or
`newdata`

is specified. This is because there is often information
associated with training observations (such as influences or related)
measures that is not meaningfully defined for new observations.

For convenience, many augment methods provide default `data`

arguments,
so that `augment(fit)`

will return the augmented training data. In these
cases augment tries to reconstruct the original data based on the model
object, with some varying degrees of success.

The augmented dataset is always returned as a tibble::tibble with the
**same number of rows** as the passed dataset. This means that the
passed data must be coercible to a tibble. At this time, tibbles do not
support matrix-columns. This means you should not specify a matrix
of covariates in a model formula during the original model fitting
process, and that `splines::ns()`

, `stats::poly()`

and
`survival::Surv()`

objects are not supported in input data. If you
encounter errors, try explicitly passing a tibble, or fitting the original
model on data in a tibble.

We are in the process of defining behaviors for models fit with various na.action arguments, but make no guarantees about behavior when data is missing at this time.

# S3 method for stl augment(x, data = NULL, weights = TRUE, ...)

x | An |
---|---|

data | Ignored, included for consistency with the augment generic signature only. |

weights | Logical indicating whether or not to include the robust weights in the output. |

... | Additional arguments. Not used. Needed to match generic
signature only. |

A tibble::tibble with one row for each observation in the original times series:

`.seasonal`

The seasonal component of the decomposition.

`.trend`

The trend component of the decomposition.

`.remainder`

The remainder, or "random" component of the decomposition.

`.weight`

The final robust weights, if requested.

`.seasadj`

The seasonally adjusted (or "deseasonalised") series.

Other decompose tidiers: `augment.decomposed.ts`