diff --git a/dev/articles/extension_models.html b/dev/articles/extension_models.html index a056cb57..7e613b70 100644 --- a/dev/articles/extension_models.html +++ b/dev/articles/extension_models.html @@ -12,7 +12,6 @@ - - +
- +
@@ -82,7 +81,7 @@

Extending fabletools: Models

- Source: vignettes/extension_models.Rmd + Source: vignettes/extension_models.Rmd
@@ -90,7 +89,10 @@

Extending fabletools: Models

+library(fabletools) +#> Registered S3 method overwritten by 'tsibble': +#> method from +#> as_tibble.grouped_df dplyr

Writing a time series model using fabletools provides your model with many additional features without extra effort. Features that aren’t model specific are handled by fabletools, allowing you to spend more @@ -672,9 +674,7 @@

Methods for models - -

+ @@ -687,16 +687,16 @@

Methods for models

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/articles/index.html b/dev/articles/index.html index d6592e22..dc0ef792 100644 --- a/dev/articles/index.html +++ b/dev/articles/index.html @@ -3,7 +3,7 @@ - +
- +
@@ -72,15 +72,15 @@

All vignettes

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/authors.html b/dev/authors.html index 717ab196..72f8661a 100644 --- a/dev/authors.html +++ b/dev/authors.html @@ -3,7 +3,7 @@ - +
- +
@@ -57,13 +57,13 @@

Authors and Citation

- +

Citation

- Source: DESCRIPTION + Source: DESCRIPTION

O'Hara-Wild M, Hyndman R, Wang E (2024). fabletools: Core Tools for Packages in the 'fable' Framework. -R package version 0.4.2.9000, -https://github.com/tidyverts/fabletools, https://fabletools.tidyverts.org/. +R package version 0.4.2.9000, +https://github.com/tidyverts/fabletools, https://fabletools.tidyverts.org/. 

@Manual{,
   title = {fabletools: Core Tools for Packages in the 'fable' Framework},
   author = {Mitchell O'Hara-Wild and Rob Hyndman and Earo Wang},
   year = {2024},
-  note = {R package version 0.4.2.9000, 
-https://github.com/tidyverts/fabletools},
+  note = {R package version 0.4.2.9000,
+    https://github.com/tidyverts/fabletools},
   url = {https://fabletools.tidyverts.org/},
 }
@@ -116,15 +116,15 @@

Citation

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/index.html b/dev/index.html index c1d1e49d..aabaf52e 100644 --- a/dev/index.html +++ b/dev/index.html @@ -20,7 +20,7 @@ - +
- +
@@ -157,16 +157,16 @@

Dev status

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/news/index.html b/dev/news/index.html index 26301b3c..e93f3f83 100644 --- a/dev/news/index.html +++ b/dev/news/index.html @@ -3,7 +3,7 @@ - +
- +

Changelog

- Source: NEWS.md + Source: NEWS.md
@@ -395,15 +395,15 @@

Evaluation -

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/pkgdown.yml b/dev/pkgdown.yml index d5e19733..5c754e70 100644 --- a/dev/pkgdown.yml +++ b/dev/pkgdown.yml @@ -1,10 +1,9 @@ pandoc: 3.1.11 -pkgdown: 2.0.9 +pkgdown: 2.1.0 pkgdown_sha: ~ articles: extension_models: extension_models.html -last_built: 2024-05-13T02:42Z +last_built: 2024-08-29T02:17Z urls: reference: https://fabletools.tidyverts.org/reference article: https://fabletools.tidyverts.org/articles - diff --git a/dev/reference/ACF1.html b/dev/reference/ACF1.html new file mode 100644 index 00000000..bb3a3e03 --- /dev/null +++ b/dev/reference/ACF1.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/CRPS.html b/dev/reference/CRPS.html new file mode 100644 index 00000000..428ad9ea --- /dev/null +++ b/dev/reference/CRPS.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/MAAPE.html b/dev/reference/MAAPE.html index 58cb06fa..92112c79 100644 --- a/dev/reference/MAAPE.html +++ b/dev/reference/MAAPE.html @@ -3,7 +3,7 @@ - +
- +

Mean Arctangent Absolute Percentage Error

- Source: R/accuracy.R + Source: R/accuracy.R
@@ -68,21 +68,23 @@

Mean Arctangent Absolute Percentage Error

Arguments

-
.resid
+ + +
.resid

A vector of residuals from either the training (model accuracy) or test (forecast accuracy) data.

-
.actual
+
.actual

A vector of responses matching the fitted values (for forecast accuracy, new_data must be provided).

-
na.rm
+
na.rm

Remove the missing values before calculating the accuracy measure

-
...
+
...

Additional arguments for each measure.

@@ -105,15 +107,15 @@

References

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/MAE.html b/dev/reference/MAE.html new file mode 100644 index 00000000..bb3a3e03 --- /dev/null +++ b/dev/reference/MAE.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/MAPE.html b/dev/reference/MAPE.html new file mode 100644 index 00000000..bb3a3e03 --- /dev/null +++ b/dev/reference/MAPE.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/MASE.html b/dev/reference/MASE.html new file mode 100644 index 00000000..bb3a3e03 --- /dev/null +++ b/dev/reference/MASE.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/MDPV.html b/dev/reference/MDPV.html new file mode 100644 index 00000000..f72eac9a --- /dev/null +++ b/dev/reference/MDPV.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/MDV.html b/dev/reference/MDV.html new file mode 100644 index 00000000..f72eac9a --- /dev/null +++ b/dev/reference/MDV.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/MPE.html b/dev/reference/MPE.html new file mode 100644 index 00000000..bb3a3e03 --- /dev/null +++ b/dev/reference/MPE.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/MSE.html b/dev/reference/MSE.html new file mode 100644 index 00000000..bb3a3e03 --- /dev/null +++ b/dev/reference/MSE.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/RMSE.html b/dev/reference/RMSE.html new file mode 100644 index 00000000..bb3a3e03 --- /dev/null +++ b/dev/reference/RMSE.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/RMSSE.html b/dev/reference/RMSSE.html new file mode 100644 index 00000000..bb3a3e03 --- /dev/null +++ b/dev/reference/RMSSE.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/accuracy.fbl_ts.html b/dev/reference/accuracy.fbl_ts.html new file mode 100644 index 00000000..f93bf5de --- /dev/null +++ b/dev/reference/accuracy.fbl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/accuracy.html b/dev/reference/accuracy.html index 88cdbe4c..bf2190c9 100644 --- a/dev/reference/accuracy.html +++ b/dev/reference/accuracy.html @@ -7,7 +7,7 @@ - +
- +

Evaluate accuracy of a forecast or model

- Source: R/accuracy.R + Source: R/accuracy.R
@@ -71,35 +71,37 @@

Evaluate accuracy of a forecast or model

- 
# S3 method for mdl_df
+    
# S3 method for class 'mdl_df'
 accuracy(object, measures = point_accuracy_measures, ...)
 
-# S3 method for mdl_ts
+# S3 method for class 'mdl_ts'
 accuracy(object, measures = point_accuracy_measures, ...)
 
-# S3 method for fbl_ts
+# S3 method for class 'fbl_ts'
 accuracy(object, data, measures = point_accuracy_measures, ..., by = NULL)

Arguments

-
object
+ + +
object

A model or forecast object

-
measures
+
measures

A list of accuracy measure functions to compute (such as point_accuracy_measures, interval_accuracy_measures, or distribution_accuracy_measures)

-
...
+
...

Additional arguments to be passed to measures that use it.

-
data
+
data

A dataset containing the complete model dataset (both training and test data). The training portion of the data will be used in the computation of some accuracy measures, and the test data is used to compute the forecast errors.

-
by
+
by

Variables over which the accuracy is computed (useful for computing across forecast horizons in cross-validation). If by is NULL, groups will be chosen automatically from the key structure.

@@ -180,15 +182,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/accuracy.mdl_ts.html b/dev/reference/accuracy.mdl_ts.html new file mode 100644 index 00000000..f93bf5de --- /dev/null +++ b/dev/reference/accuracy.mdl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/agg_vec.html b/dev/reference/agg_vec.html index 127db74d..701f7eea 100644 --- a/dev/reference/agg_vec.html +++ b/dev/reference/agg_vec.html @@ -3,7 +3,7 @@ - +
- +

Create an aggregation vector

- Source: R/aggregate.R + Source: R/aggregate.R
@@ -68,11 +68,13 @@

Create an aggregation vector

Arguments

-
x
+ + +
x

The vector of values.

-
aggregated
+
aggregated

A logical vector to identify which values are <aggregated>.

@@ -107,15 +109,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/aggregate_index.html b/dev/reference/aggregate_index.html index a47dd471..bbcce5a9 100644 --- a/dev/reference/aggregate_index.html +++ b/dev/reference/aggregate_index.html @@ -3,7 +3,7 @@ - +
- +

Expand a dataset to include temporal aggregates

- Source: R/temporal_aggregation.R + Source: R/temporal_aggregation.R
@@ -68,17 +68,19 @@

Expand a dataset to include temporal aggregates

Arguments

-
.data
+ + +
.data

A tsibble.

-
.window
+
.window

Temporal aggregations to include. The default (NULL) will automatically identify appropriate temporal aggregations. This can be specified in several ways (see details).

-
...
+
...

<data-masking> Name-value pairs of summary functions. The name will be the name of the variable in the result.

The value can be:

  • A vector of length 1, e.g. min(x), n(), or sum(is.na(y)).

    • @@ -87,13 +89,13 @@

    Arguments

    deprecated as of 1.1.0. Please use reframe() for this instead.

-
.offset
+
.offset

Offset the temporal aggregation windows to align with the start or end of the data. If FALSE, no offset will be applied (giving common breakpoints for temporal bins.)

-
.bin_size
+
.bin_size

Temporary. Define the number of observations in each temporal bucket

@@ -145,15 +147,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/aggregate_key.html b/dev/reference/aggregate_key.html index 04564d9c..c2217b56 100644 --- a/dev/reference/aggregate_key.html +++ b/dev/reference/aggregate_key.html @@ -7,7 +7,7 @@ - +
- +

Expand a dataset to include other levels of aggregation

- Source: R/aggregate.R + Source: R/aggregate.R
@@ -76,15 +76,17 @@

Expand a dataset to include other levels of aggregation

Arguments

-
.data
+ + +
.data

A tsibble.

-
.spec
+
.spec

The specification of aggregation structure.

-
...
+
...

<data-masking> Name-value pairs of summary functions. The name will be the name of the variable in the result.

The value can be:

  • A vector of length 1, e.g. min(x), n(), or sum(is.na(y)).

    • @@ -140,15 +142,15 @@

    Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/aggregation-vctrs.html b/dev/reference/aggregation-vctrs.html index 90725c8f..e55bed83 100644 --- a/dev/reference/aggregation-vctrs.html +++ b/dev/reference/aggregation-vctrs.html @@ -4,7 +4,7 @@ - +
- +

Internal vctrs methods

- Source: R/aggregate.R + Source: R/aggregate.R
@@ -65,37 +65,37 @@

Internal vctrs methods

- 
# S3 method for agg_vec
+    
# S3 method for class 'agg_vec'
 vec_ptype2(x, y, ...)
 
-# S3 method for agg_vec.agg_vec
+# S3 method for class 'agg_vec.agg_vec'
 vec_ptype2(x, y, ...)
 
-# S3 method for agg_vec.default
+# S3 method for class 'agg_vec.default'
 vec_ptype2(x, y, ...)
 
-# S3 method for agg_vec.character
+# S3 method for class 'agg_vec.character'
 vec_ptype2(x, y, ...)
 
-# S3 method for character.agg_vec
+# S3 method for class 'character.agg_vec'
 vec_ptype2(x, y, ...)
 
-# S3 method for agg_vec
+# S3 method for class 'agg_vec'
 vec_ptype_abbr(x, ...)
 
-# S3 method for agg_vec
+# S3 method for class 'agg_vec'
 vec_cast(x, to, ...)
 
-# S3 method for agg_vec.agg_vec
+# S3 method for class 'agg_vec.agg_vec'
 vec_cast(x, to, ...)
 
-# S3 method for agg_vec.default
+# S3 method for class 'agg_vec.default'
 vec_cast(x, to, ...)
 
-# S3 method for character.agg_vec
+# S3 method for class 'character.agg_vec'
 vec_cast(x, to, ...)
 
-# S3 method for agg_vec
+# S3 method for class 'agg_vec'
 vec_proxy_compare(x, ...)
@@ -112,15 +112,15 @@

Internal vctrs methods

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/as-dable.html b/dev/reference/as-dable.html index 87c2f307..05ebf97d 100644 --- a/dev/reference/as-dable.html +++ b/dev/reference/as-dable.html @@ -3,7 +3,7 @@ - +
- +

Coerce to a dable object

- Source: R/dable.R + Source: R/dable.R
@@ -65,37 +65,39 @@

Coerce to a dable object

as_dable(x, ...)
 
-# S3 method for tbl_df
+# S3 method for class 'tbl_df'
 as_dable(x, response, method = NULL, seasons = list(), aliases = list(), ...)
 
-# S3 method for tbl_ts
+# S3 method for class 'tbl_ts'
 as_dable(x, response, method = NULL, seasons = list(), aliases = list(), ...)

Arguments

-
x
+ + +
x

Object to be coerced to a dable (dcmp_ts)

-
...
+
...

Additional arguments passed to methods

-
response
+
response

The character vector of response variable(s).

-
method
+
method

The name of the decomposition method.

-
seasons
+
seasons

A named list describing the structure of seasonal components (such as period, and base).

-
aliases
+
aliases

A named list of calls describing common aliases computed from components.

@@ -113,15 +115,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/as-fable.html b/dev/reference/as-fable.html index 4cc99348..0a6236b9 100644 --- a/dev/reference/as-fable.html +++ b/dev/reference/as-fable.html @@ -3,7 +3,7 @@ - +
- +

Coerce to a fable object

- Source: R/fable.R + Source: R/fable.R
@@ -65,45 +65,47 @@

Coerce to a fable object

as_fable(x, ...)
 
-# S3 method for tbl_ts
+# S3 method for class 'tbl_ts'
 as_fable(x, response, distribution, ...)
 
-# S3 method for grouped_ts
+# S3 method for class 'grouped_ts'
 as_fable(x, response, distribution, ...)
 
-# S3 method for tbl_df
+# S3 method for class 'tbl_df'
 as_fable(x, response, distribution, ...)
 
-# S3 method for fbl_ts
+# S3 method for class 'fbl_ts'
 as_fable(x, response, distribution, ...)
 
-# S3 method for grouped_df
+# S3 method for class 'grouped_df'
 as_fable(x, response, distribution, ...)
 
-# S3 method for forecast
+# S3 method for class 'forecast'
 as_fable(x, ..., point_forecast = list(.mean = mean))

Arguments

-
x
+ + +
x

Object to be coerced to a fable (fbl_ts)

-
...
+
...

Additional arguments passed to methods

-
response
+
response

The character vector of response variable(s).

-
distribution
+
distribution

The name of the distribution column (can be provided using a bare expression).

-
point_forecast
+
point_forecast

The point forecast measure(s) which should be returned in the resulting fable. Specified as a named list of functions which accept a distribution and return a vector. To compute forecast medians, you can use @@ -123,15 +125,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/as_dable.tbl_df.html b/dev/reference/as_dable.tbl_df.html new file mode 100644 index 00000000..1d586d4c --- /dev/null +++ b/dev/reference/as_dable.tbl_df.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/as_dable.tbl_ts.html b/dev/reference/as_dable.tbl_ts.html new file mode 100644 index 00000000..1d586d4c --- /dev/null +++ b/dev/reference/as_dable.tbl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/as_fable.fbl_ts.html b/dev/reference/as_fable.fbl_ts.html new file mode 100644 index 00000000..8ce043d9 --- /dev/null +++ b/dev/reference/as_fable.fbl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/as_fable.forecast.html b/dev/reference/as_fable.forecast.html new file mode 100644 index 00000000..8ce043d9 --- /dev/null +++ b/dev/reference/as_fable.forecast.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/as_fable.grouped_df.html b/dev/reference/as_fable.grouped_df.html new file mode 100644 index 00000000..8ce043d9 --- /dev/null +++ b/dev/reference/as_fable.grouped_df.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/as_fable.grouped_ts.html b/dev/reference/as_fable.grouped_ts.html new file mode 100644 index 00000000..8ce043d9 --- /dev/null +++ b/dev/reference/as_fable.grouped_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/as_fable.tbl_df.html b/dev/reference/as_fable.tbl_df.html new file mode 100644 index 00000000..8ce043d9 --- /dev/null +++ b/dev/reference/as_fable.tbl_df.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/as_fable.tbl_ts.html b/dev/reference/as_fable.tbl_ts.html new file mode 100644 index 00000000..8ce043d9 --- /dev/null +++ b/dev/reference/as_fable.tbl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/as_mable.data.frame.html b/dev/reference/as_mable.data.frame.html new file mode 100644 index 00000000..6723b590 --- /dev/null +++ b/dev/reference/as_mable.data.frame.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/as_mable.html b/dev/reference/as_mable.html index cf406cb7..18d527f4 100644 --- a/dev/reference/as_mable.html +++ b/dev/reference/as_mable.html @@ -3,7 +3,7 @@ - +
- +

Coerce a dataset to a mable

- Source: R/mable.R + Source: R/mable.R
@@ -65,25 +65,27 @@

Coerce a dataset to a mable

as_mable(x, ...)
 
-# S3 method for data.frame
+# S3 method for class 'data.frame'
 as_mable(x, key = NULL, model = NULL, ...)

Arguments

-
x
+ + +
x

A dataset containing a list model column.

-
...
+
...

Additional arguments passed to other methods.

-
key
+
key

Structural variable(s) that identify each model.

-
model
+
model

Identifiers for the columns containing model(s).

@@ -100,15 +102,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/as_tsibble.html b/dev/reference/as_tsibble.html new file mode 100644 index 00000000..1182a598 --- /dev/null +++ b/dev/reference/as_tsibble.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/augment.html b/dev/reference/augment.html index 23609edd..5c591e43 100644 --- a/dev/reference/augment.html +++ b/dev/reference/augment.html @@ -6,7 +6,7 @@ - +
- +

Augment a mable

- Source: R/broom.R + Source: R/broom.R
@@ -69,24 +69,26 @@

Augment a mable

- 
# S3 method for mdl_df
+    
# S3 method for class 'mdl_df'
 augment(x, ...)
 
-# S3 method for mdl_ts
+# S3 method for class 'mdl_ts'
 augment(x, type = NULL, ...)

Arguments

-
x
+ + +
x

A mable.

-
...
+
...

Arguments for model methods.

-
type
+
type

Deprecated.

@@ -129,15 +131,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/augment.mdl_ts.html b/dev/reference/augment.mdl_ts.html new file mode 100644 index 00000000..0f8a5fff --- /dev/null +++ b/dev/reference/augment.mdl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/autolayer.fbl_ts.html b/dev/reference/autolayer.fbl_ts.html new file mode 100644 index 00000000..162659fe --- /dev/null +++ b/dev/reference/autolayer.fbl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/autolayer.html b/dev/reference/autolayer.html new file mode 100644 index 00000000..1182a598 --- /dev/null +++ b/dev/reference/autolayer.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/autolayer.tbl_ts.html b/dev/reference/autolayer.tbl_ts.html new file mode 100644 index 00000000..09fac1d6 --- /dev/null +++ b/dev/reference/autolayer.tbl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/autoplot.dcmp_ts-1.png b/dev/reference/autoplot.dcmp_ts-1.png index 3a5eb61f..5efecb21 100644 Binary files a/dev/reference/autoplot.dcmp_ts-1.png and b/dev/reference/autoplot.dcmp_ts-1.png differ diff --git a/dev/reference/autoplot.dcmp_ts.html b/dev/reference/autoplot.dcmp_ts.html index b782b66e..6abb2f78 100644 --- a/dev/reference/autoplot.dcmp_ts.html +++ b/dev/reference/autoplot.dcmp_ts.html @@ -5,7 +5,7 @@ - +
- +

Decomposition plots

- Source: R/plot.R + Source: R/plot.R
@@ -67,29 +67,31 @@

Decomposition plots

- 
# S3 method for dcmp_ts
+    
# S3 method for class 'dcmp_ts'
 autoplot(object, .vars = NULL, scale_bars = TRUE, level = c(80, 95), ...)

Arguments

-
object
+ + +
object

A dable.

-
.vars
+
.vars

The column of the dable used to plot. By default, this will be the response variable of the decomposition.

-
scale_bars
+
scale_bars

If TRUE, each facet will include a scale bar which represents the same units across each facet.

-
level
+
level

If the decomposition contains distributions, which levels should be used to display intervals?

-
...
+
...

Further arguments passed to ggplot2::geom_line(), which can be used to specify fixed aesthetics such as colour = "red" or linewidth = 3.

@@ -117,15 +119,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/autoplot.fbl_ts.html b/dev/reference/autoplot.fbl_ts.html index 6a256bc0..63fc2fb8 100644 --- a/dev/reference/autoplot.fbl_ts.html +++ b/dev/reference/autoplot.fbl_ts.html @@ -6,7 +6,7 @@ - +
- +

Plot a set of forecasts

- Source: R/plot.R + Source: R/plot.R
@@ -69,10 +69,10 @@

Plot a set of forecasts

- 
# S3 method for fbl_ts
+    
# S3 method for class 'fbl_ts'
 autoplot(object, data = NULL, level = c(80, 95), show_gap = TRUE, ...)
 
-# S3 method for fbl_ts
+# S3 method for class 'fbl_ts'
 autolayer(
   object,
   data = NULL,
@@ -85,27 +85,29 @@ 
Plot a set of forecasts

 
     

     
Arguments

-    
object

+
+
+
object

 
A fable.

 
 
-
data

+
data

 
A tsibble with the same key structure as the fable.

 
 
-
level

+
level

 
The confidence level(s) for the plotted intervals.

 
 
-
show_gap

+
show_gap

 
Setting this to FALSE will connect the most recent value in data with the forecasts.

 
 
-
...

+
...

 
Further arguments passed used to specify fixed aesthetics for the forecasts such as colour = "red" or linewidth = 3.

 
 
-
point_forecast

+
point_forecast

 
The point forecast measure to be displayed in the plot.

 
 

@@ -140,15 +142,15 @@ 
Examples

 

 
 

-  
Site built with pkgdown 2.0.9.

+  
Site built with pkgdown 2.1.0.
- - + + diff --git a/dev/reference/autoplot.html b/dev/reference/autoplot.html new file mode 100644 index 00000000..1182a598 --- /dev/null +++ b/dev/reference/autoplot.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/autoplot.tbl_ts.html b/dev/reference/autoplot.tbl_ts.html index 0fa0551f..44d5d30e 100644 --- a/dev/reference/autoplot.tbl_ts.html +++ b/dev/reference/autoplot.tbl_ts.html @@ -5,7 +5,7 @@ - +
- +

Plot time series from a tsibble

- Source: R/plot.R + Source: R/plot.R
@@ -67,24 +67,26 @@

Plot time series from a tsibble

- 
# S3 method for tbl_ts
+    
# S3 method for class 'tbl_ts'
 autoplot(object, .vars = NULL, ...)
 
-# S3 method for tbl_ts
+# S3 method for class 'tbl_ts'
 autolayer(object, .vars = NULL, ...)

Arguments

-
object
+ + +
object

A tsibble.

-
.vars
+
.vars

A bare expression containing data you wish to plot. Multiple variables can be plotted using ggplot2::vars().

-
...
+
...

Further arguments passed to ggplot2::geom_line(), which can be used to specify fixed aesthetics such as colour = "red" or linewidth = 3.

@@ -112,15 +114,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/bias_adjust.html b/dev/reference/bias_adjust.html index 75cfe4d8..cee01739 100644 --- a/dev/reference/bias_adjust.html +++ b/dev/reference/bias_adjust.html @@ -3,7 +3,7 @@ - +
- +

Bias adjust back-transformation functions

- Source: R/transform.R + Source: R/transform.R
@@ -68,11 +68,13 @@

Bias adjust back-transformation functions

Arguments

-
bt
+ + +
bt

The back-transformation function

-
sd
+
sd

The forecast standard deviation

@@ -108,15 +110,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/bottom_up.html b/dev/reference/bottom_up.html index 854b78ce..d558683d 100644 --- a/dev/reference/bottom_up.html +++ b/dev/reference/bottom_up.html @@ -3,7 +3,7 @@ - +
- +

Bottom up forecast reconciliation

- Source: R/reconciliation.R + Source: R/reconciliation.R
@@ -68,7 +68,9 @@

Bottom up forecast reconciliation

Arguments

-
models
+ + +
models

A column of models in a mable.

@@ -95,15 +97,15 @@

See also

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/box_cox.html b/dev/reference/box_cox.html index af1fd2a0..32457663 100644 --- a/dev/reference/box_cox.html +++ b/dev/reference/box_cox.html @@ -4,7 +4,7 @@ - +
- +

Box Cox Transformation

- Source: R/box_cox.R + Source: R/box_cox.R
@@ -72,19 +72,19 @@

Box Cox Transformation

Arguments

-
x
+ + +
x

a numeric vector.

-
lambda
+
lambda

a numeric value for the transformation parameter.

Value

- - -

a transformed numeric vector of the same length as x.

+

a transformed numeric vector of the same length as x.

Details

@@ -95,7 +95,7 @@

Details

References

Box, G. E. P. and Cox, D. R. (1964) An analysis of -transformations. JRSS B 26 211--246.

+transformations. JRSS B 26 211–246.

Author

@@ -138,15 +138,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/coef.mdl_df.html b/dev/reference/coef.mdl_df.html new file mode 100644 index 00000000..a32634e0 --- /dev/null +++ b/dev/reference/coef.mdl_df.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/coef.mdl_ts.html b/dev/reference/coef.mdl_ts.html new file mode 100644 index 00000000..a32634e0 --- /dev/null +++ b/dev/reference/coef.mdl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/combination_ensemble.html b/dev/reference/combination_ensemble.html index c266ef3c..142857d5 100644 --- a/dev/reference/combination_ensemble.html +++ b/dev/reference/combination_ensemble.html @@ -3,7 +3,7 @@ - +
- +

Ensemble combination

- Source: R/model_combination.R + Source: R/model_combination.R
@@ -68,11 +68,13 @@

Ensemble combination

Arguments

-
...
+ + +
...

Estimated models used in the ensemble.

-
weights
+
weights

The method used to weight each model in the ensemble.

@@ -93,15 +95,15 @@

See also

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/combination_model.html b/dev/reference/combination_model.html index a9c5bfff..c2fbe43c 100644 --- a/dev/reference/combination_model.html +++ b/dev/reference/combination_model.html @@ -6,7 +6,7 @@ - +
- +

Combination modelling

- Source: R/model_combination.R + Source: R/model_combination.R
@@ -74,15 +74,17 @@

Combination modelling

Arguments

-
...
+ + +
...

Model definitions used in the combination.

-
cmbn_fn
+
cmbn_fn

A function used to produce the combination.

-
cmbn_args
+
cmbn_args

Additional arguments passed to cmbn_fn.

@@ -134,15 +136,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/combination_weighted.html b/dev/reference/combination_weighted.html index 1cad1066..0f9b687a 100644 --- a/dev/reference/combination_weighted.html +++ b/dev/reference/combination_weighted.html @@ -3,7 +3,7 @@ - +
- +

Weighted combination

- Source: R/model_combination.R + Source: R/model_combination.R
@@ -68,11 +68,13 @@

Weighted combination

Arguments

-
...
+ + +
...

Estimated models used in the ensemble.

-
weights
+
weights

The numeric weights applied to each model in ...

@@ -93,15 +95,15 @@

See also

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/common_periods.default.html b/dev/reference/common_periods.default.html new file mode 100644 index 00000000..9a69f88f --- /dev/null +++ b/dev/reference/common_periods.default.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/common_periods.interval.html b/dev/reference/common_periods.interval.html new file mode 100644 index 00000000..9a69f88f --- /dev/null +++ b/dev/reference/common_periods.interval.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/common_periods.tbl_ts.html b/dev/reference/common_periods.tbl_ts.html new file mode 100644 index 00000000..9a69f88f --- /dev/null +++ b/dev/reference/common_periods.tbl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/common_xregs.html b/dev/reference/common_xregs.html index c126d2b3..940e1400 100644 --- a/dev/reference/common_xregs.html +++ b/dev/reference/common_xregs.html @@ -4,7 +4,7 @@ - +
- +

Common exogenous regressors

- Source: R/xregs.R + Source: R/xregs.R
@@ -70,7 +70,7 @@

Common exogenous regressors

Specials

- +
@@ -108,15 +108,15 @@

fourier
-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/components.html b/dev/reference/components.html index b4a281cc..b1d32ada 100644 --- a/dev/reference/components.html +++ b/dev/reference/components.html @@ -4,7 +4,7 @@ - +
- +

Extract components from a fitted model

- Source: R/components.R + Source: R/components.R
@@ -65,20 +65,22 @@

Extract components from a fitted model

- 
# S3 method for mdl_df
+    
# S3 method for class 'mdl_df'
 components(object, ...)
 
-# S3 method for mdl_ts
+# S3 method for class 'mdl_ts'
 components(object, ...)

Arguments

-
object
+ + +
object

A mable.

-
...
+
...

Other arguments passed to methods.

@@ -115,15 +117,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/components.mdl_ts.html b/dev/reference/components.mdl_ts.html new file mode 100644 index 00000000..a8d137e4 --- /dev/null +++ b/dev/reference/components.mdl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/construct_fc.html b/dev/reference/construct_fc.html index bd29a6c4..148a1018 100644 --- a/dev/reference/construct_fc.html +++ b/dev/reference/construct_fc.html @@ -6,7 +6,7 @@ - +
- +

Construct a new set of forecasts

- Source: R/forecast.R + Source: R/forecast.R
@@ -74,15 +74,17 @@

Construct a new set of forecasts

Arguments

-
point
+ + +
point

The transformed point forecasts

-
sd
+
sd

The standard deviation of the transformed forecasts

-
dist
+
dist

The forecast distribution (typically produced using new_fcdist)

@@ -99,15 +101,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/dable-vctrs.html b/dev/reference/dable-vctrs.html index 68a87cf0..c0d8186e 100644 --- a/dev/reference/dable-vctrs.html +++ b/dev/reference/dable-vctrs.html @@ -4,7 +4,7 @@ - +
- +

Internal vctrs methods

- Source: R/vctrs-dable.R + Source: R/vctrs-dable.R
@@ -65,10 +65,10 @@

Internal vctrs methods

- 
# S3 method for dcmp_ts
+    
# S3 method for class 'dcmp_ts'
 vec_ptype2(x, y, ...)
 
-# S3 method for dcmp_ts
+# S3 method for class 'dcmp_ts'
 vec_cast(x, to, ...)
@@ -85,15 +85,15 @@

Internal vctrs methods

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/dable.html b/dev/reference/dable.html index a1b3815a..e62e5dc5 100644 --- a/dev/reference/dable.html +++ b/dev/reference/dable.html @@ -8,7 +8,7 @@ - +
- +

Create a dable object

- Source: R/dable.R + Source: R/dable.R
@@ -78,24 +78,26 @@

Create a dable object

Arguments

-
...
+ + +
...

Arguments passed to tsibble::tsibble().

-
response
+
response

The name of the response variable column.

-
method
+
method

The name of the decomposition method.

-
seasons
+
seasons

A named list describing the structure of seasonal components (such as period, and base).

-
aliases
+
aliases

A named list of calls describing common aliases computed from components.

@@ -113,15 +115,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/decomposition_model.html b/dev/reference/decomposition_model.html index 2304167e..0a4b3966 100644 --- a/dev/reference/decomposition_model.html +++ b/dev/reference/decomposition_model.html @@ -11,7 +11,7 @@ - +
- +

Decomposition modelling

- Source: R/model_decomposition.R + Source: R/model_decomposition.R
@@ -84,11 +84,13 @@

Decomposition modelling

Arguments

-
dcmp
+ + +
dcmp

A model definition which supports extracting decomposed components().

-
...
+
...

Model definitions used to model the components

@@ -140,15 +142,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/directional_accuracy_measures.html b/dev/reference/directional_accuracy_measures.html index be6f1d7e..e8e8c11f 100644 --- a/dev/reference/directional_accuracy_measures.html +++ b/dev/reference/directional_accuracy_measures.html @@ -4,7 +4,7 @@ - +
- +

Directional accuracy measures

- Source: R/accuracy.R + Source: R/accuracy.R
@@ -80,26 +80,28 @@

Format

Arguments

-
.resid
+ + +
.resid

A vector of residuals from either the training (model accuracy) or test (forecast accuracy) data.

-
.actual
+
.actual

A vector of responses matching the fitted values (for forecast accuracy, new_data must be provided).

-
na.rm
+
na.rm

Remove the missing values before calculating the accuracy measure

-
reward, penalty
+
reward, penalty

The weights given to correct and incorrect predicted directions.

-
...
+
...

Additional arguments for each measure.

@@ -127,15 +129,15 @@

References

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/distribution_accuracy_measures.html b/dev/reference/distribution_accuracy_measures.html index af46d2ed..9a83af6f 100644 --- a/dev/reference/distribution_accuracy_measures.html +++ b/dev/reference/distribution_accuracy_measures.html @@ -4,7 +4,7 @@ - +
- +

Distribution accuracy measures

- Source: R/accuracy.R + Source: R/accuracy.R
@@ -86,34 +86,36 @@

Format

Arguments

-
.dist
+ + +
.dist

The distribution of fitted values from the model, or forecasted values from the forecast.

-
.actual
+
.actual

A vector of responses matching the fitted values (for forecast accuracy, new_data must be provided).

-
na.rm
+
na.rm

Remove the missing values before calculating the accuracy measure

-
...
+
...

Additional arguments for each measure.

-
probs
+
probs

A vector of probabilities at which the metric is evaluated.

-
n_quantiles
+
n_quantiles

The number of quantiles to use in approximating CRPS when an exact solution is not available.

Quantile/percentile score (pinball loss)

- +

A quantile (or percentile) score evaluates how accurately a set of quantiles @@ -131,7 +133,7 @@

Quantile/percentile score (pinball loss)

Continuous ranked probability score (CRPS)

- +

The continuous ranked probability score (CRPS) is the continuous analogue of @@ -164,15 +166,15 @@

Continuous ranked probability score (CRPS)

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/distribution_var.html b/dev/reference/distribution_var.html index 1752a888..cb145190 100644 --- a/dev/reference/distribution_var.html +++ b/dev/reference/distribution_var.html @@ -4,7 +4,7 @@ - +
- +

Return distribution variable

- Source: R/accessors.R + Source: R/accessors.R
@@ -70,7 +70,9 @@

Return distribution variable

Arguments

-
x
+ + +
x

A dataset containing a distribution variable (such as a fable).

@@ -87,15 +89,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/equation.html b/dev/reference/equation.html new file mode 100644 index 00000000..1182a598 --- /dev/null +++ b/dev/reference/equation.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/estimate.html b/dev/reference/estimate.html index c248450f..8ae27b96 100644 --- a/dev/reference/estimate.html +++ b/dev/reference/estimate.html @@ -3,7 +3,7 @@ - +
- +

Estimate a model

- Source: R/estimate.R + Source: R/estimate.R
@@ -65,21 +65,23 @@

Estimate a model

estimate(.data, ...)
 
-# S3 method for tbl_ts
+# S3 method for class 'tbl_ts'
 estimate(.data, .model, ...)

Arguments

-
.data
+ + +
.data

A data structure suitable for the models (such as a tsibble).

-
...
+
...

Further arguments passed to methods.

-
.model
+
.model

Definition for the model to be used.

@@ -96,15 +98,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/estimate.tbl_ts.html b/dev/reference/estimate.tbl_ts.html new file mode 100644 index 00000000..d2f11db4 --- /dev/null +++ b/dev/reference/estimate.tbl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/fable-vctrs.html b/dev/reference/fable-vctrs.html index f2a487d9..ef75154e 100644 --- a/dev/reference/fable-vctrs.html +++ b/dev/reference/fable-vctrs.html @@ -4,7 +4,7 @@ - +
- +

Internal vctrs methods

- Source: R/vctrs-fable.R + Source: R/vctrs-fable.R
@@ -65,10 +65,10 @@

Internal vctrs methods

- 
# S3 method for fbl_ts
+    
# S3 method for class 'fbl_ts'
 vec_ptype2(x, y, ...)
 
-# S3 method for fbl_ts
+# S3 method for class 'fbl_ts'
 vec_cast(x, to, ...)
@@ -85,15 +85,15 @@

Internal vctrs methods

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/fable.html b/dev/reference/fable.html index f5683f10..4b349262 100644 --- a/dev/reference/fable.html +++ b/dev/reference/fable.html @@ -6,7 +6,7 @@ - +
- +

Create a fable object

- Source: R/fable.R + Source: R/fable.R
@@ -74,15 +74,17 @@

Create a fable object

Arguments

-
...
+ + +
...

Arguments passed to tsibble::tsibble().

-
response
+
response

The character vector of response variable(s).

-
distribution
+
distribution

The name of the distribution column (can be provided using a bare expression).

@@ -100,15 +102,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/fabletools-package.html b/dev/reference/fabletools-package.html index f2475b79..0addad76 100644 --- a/dev/reference/fabletools-package.html +++ b/dev/reference/fabletools-package.html @@ -3,7 +3,7 @@ - +
- +

fabletools: Core Tools for Packages in the 'fable' Framework

- Source: R/fabletools-package.R + Source: R/fabletools-package.R
@@ -92,15 +92,15 @@

Author

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/fabletools.html b/dev/reference/fabletools.html new file mode 100644 index 00000000..d04bbb37 --- /dev/null +++ b/dev/reference/fabletools.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/feature_set.html b/dev/reference/feature_set.html index e095e9b1..bdcc28e2 100644 --- a/dev/reference/feature_set.html +++ b/dev/reference/feature_set.html @@ -8,7 +8,7 @@ - +
- +

Create a feature set from tags

- Source: R/features.R + Source: R/features.R
@@ -75,19 +75,21 @@

Create a feature set from tags

Arguments

-
pkgs
+ + +
pkgs

The package(s) from which to search for features. If NULL, all registered features from currently loaded packages will be searched.

-
tags
+
tags

Tags used to identify similar groups of features. If NULL, all tags will be included.

Registering features

- +

Features can be registered for use with the feature_set() function using register_feature(). This function allows you to register a feature along @@ -108,15 +110,15 @@

Registering features

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/features.html b/dev/reference/features.html index fb4de03f..544833bd 100644 --- a/dev/reference/features.html +++ b/dev/reference/features.html @@ -3,7 +3,7 @@ - +
- +

Extract features from a dataset

- Source: R/features.R + Source: R/features.R
@@ -74,27 +74,29 @@

Extract features from a dataset

Arguments

-
.tbl
+ + +
.tbl

A dataset

-
.var
+
.var

An expression that produces a vector from which the features are computed.

-
features
+
features

A list of functions (or lambda expressions) for the features to compute. feature_set() is a useful helper for building sets of features.

-
...
+
...

Additional arguments to be passed to each feature. These arguments will only be passed to features which use it in their formal arguments (base::formals()), and not via their .... While passing na.rm = TRUE to stats::var() will work, it will not for base::mean() as its formals are x and .... To more precisely pass inputs to each function, you should use lambdas in the list of features (~ mean(., na.rm = TRUE)).

-
.vars
+
.vars

A tidyselect compatible selection of the column(s) to compute features on.

-
.predicate
+
.predicate

A predicate function (or lambda expression) to be applied to the columns or a logical vector. The variables for which .predicate is or returns TRUE are selected.

@@ -184,15 +186,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/features_all.html b/dev/reference/features_all.html new file mode 100644 index 00000000..41165d1d --- /dev/null +++ b/dev/reference/features_all.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/features_at.html b/dev/reference/features_at.html new file mode 100644 index 00000000..41165d1d --- /dev/null +++ b/dev/reference/features_at.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/features_by_pkg.html b/dev/reference/features_by_pkg.html index d65e439f..79f7b9be 100644 --- a/dev/reference/features_by_pkg.html +++ b/dev/reference/features_by_pkg.html @@ -4,7 +4,7 @@ - +
- +

Features by package

- Source: R/features.R + Source: R/features.R
@@ -109,15 +109,15 @@

See also

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/features_by_tag.html b/dev/reference/features_by_tag.html index e602081c..7ff13a73 100644 --- a/dev/reference/features_by_tag.html +++ b/dev/reference/features_by_tag.html @@ -4,7 +4,7 @@ - +
- +

Features by tag

- Source: R/features.R + Source: R/features.R
@@ -170,15 +170,15 @@

See also

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/features_if.html b/dev/reference/features_if.html new file mode 100644 index 00000000..41165d1d --- /dev/null +++ b/dev/reference/features_if.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/fitted.mdl_df.html b/dev/reference/fitted.mdl_df.html index fac92d50..dd582ef9 100644 --- a/dev/reference/fitted.mdl_df.html +++ b/dev/reference/fitted.mdl_df.html @@ -5,7 +5,7 @@ - +
- +

Extract fitted values from models

- Source: R/fitted.R + Source: R/fitted.R
@@ -67,24 +67,26 @@

Extract fitted values from models

- 
# S3 method for mdl_df
+    
# S3 method for class 'mdl_df'
 fitted(object, ...)
 
-# S3 method for mdl_ts
+# S3 method for class 'mdl_ts'
 fitted(object, h = 1, ...)

Arguments

-
object
+ + +
object

A mable or time series model.

-
...
+
...

Other arguments passed to the model method for fitted()

-
h
+
h

The number of steps ahead that these fitted values are computed from.

@@ -101,15 +103,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/fitted.mdl_ts.html b/dev/reference/fitted.mdl_ts.html new file mode 100644 index 00000000..fa97d965 --- /dev/null +++ b/dev/reference/fitted.mdl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/forecast.html b/dev/reference/forecast.html index 6cbacbbf..dcef84ab 100644 --- a/dev/reference/forecast.html +++ b/dev/reference/forecast.html @@ -8,7 +8,7 @@ - +
- +

Produce forecasts

- Source: R/forecast.R + Source: R/forecast.R
@@ -73,7 +73,7 @@

Produce forecasts

- 
# S3 method for mdl_df
+    
# S3 method for class 'mdl_df'
 forecast(
   object,
   new_data = NULL,
@@ -82,7 +82,7 @@ 
Produce forecasts

   ...
 )
 
-# S3 method for mdl_ts
+# S3 method for class 'mdl_ts'
 forecast(
   object,
   new_data = NULL,
@@ -98,56 +98,56 @@ 
Produce forecasts

 
     

     
Arguments

-    
object

+
+
+
object

 
The time series model used to produce the forecasts

 
 
-
new_data

+
new_data

 
A tsibble containing future information used to forecast.

 
 
-
h

+
h

 
The forecast horison (can be used instead of new_data for regular
 time series with no exogenous regressors).

 
 
-
point_forecast

+
point_forecast

 
The point forecast measure(s) which should be returned
 in the resulting fable. Specified as a named list of functions which accept
 a distribution and return a vector. To compute forecast medians, you can use
 list(.median = median).

 
 
-
...

+
...

 
Additional arguments for forecast model methods.

 
 
-
bias_adjust

+
bias_adjust

 
Deprecated. Please use point_forecast to specify the
 desired point forecast method.

 
 
-
simulate

+
simulate

 
Should forecasts be based on simulated future paths instead
 of analytical results.

 
 
-
bootstrap

+
bootstrap

 
Should innovations from simulated forecasts be bootstrapped
 from the model's fitted residuals. This allows the forecast distribution to
 have a different underlying shape which could better represent the nature
 of your data.

 
 
-
times

+
times

 
The number of future paths for simulations if simulate = TRUE.

 
 

     

     
Value

-    
-
-
A fable containing the following columns:
  • .model: The name of the model used to obtain the forecast. Taken from
+    
    A fable containing the following columns:
    • .model: The name of the model used to obtain the forecast. Taken from
 the column names of models in the provided mable.
      • 
 
    • The forecast distribution. The name of this column will be the same as the
 dependent variable in the model(s). If multiple dependent variables exist,
@@ -252,15 +252,15 @@ 
      Examples
      
 

 
 

-  
Site built with pkgdown 2.0.9.

+  
Site built with pkgdown 2.1.0.

 

 
       

 
-  
 
 
-  
+
+
 
   
 
diff --git a/dev/reference/forecast.mdl_ts.html b/dev/reference/forecast.mdl_ts.html
new file mode 100644
index 00000000..9551d319
--- /dev/null
+++ b/dev/reference/forecast.mdl_ts.html
@@ -0,0 +1,8 @@
+
+  
+    
+    
+    
+  
+
+
diff --git a/dev/reference/freq_tools.html b/dev/reference/freq_tools.html
index 29c228d6..2f395865 100644
--- a/dev/reference/freq_tools.html
+++ b/dev/reference/freq_tools.html
@@ -3,7 +3,7 @@
 
 
 
-    
+
- +

Extract frequencies for common seasonal periods

- Source: R/frequency.R + Source: R/frequency.R
@@ -65,58 +65,58 @@

Extract frequencies for common seasonal periods

common_periods(x)
 
-# S3 method for default
+# Default S3 method
 common_periods(x)
 
-# S3 method for tbl_ts
+# S3 method for class 'tbl_ts'
 common_periods(x)
 
-# S3 method for interval
+# S3 method for class 'interval'
 common_periods(x)
 
 get_frequencies(period, ...)
 
-# S3 method for numeric
+# S3 method for class 'numeric'
 get_frequencies(period, ...)
 
-# S3 method for `NULL`
+# S3 method for class '`NULL`'
 get_frequencies(period, data, ..., .auto = c("smallest", "largest", "all"))
 
-# S3 method for character
+# S3 method for class 'character'
 get_frequencies(period, data, ...)
 
-# S3 method for Period
+# S3 method for class 'Period'
 get_frequencies(period, data, ...)

Arguments

-
x
+ + +
x

An object containing temporal data (such as a tsibble, interval, datetime and others.)

-
period
+
period

Specification of the time-series period

-
...
+
...

Other arguments to be passed on to methods

-
data
+
data

A tsibble

-
.auto
+
.auto

The method used to automatically select the appropriate seasonal periods

Value

- - -

A named vector of frequencies appropriate for the provided data.

+

A named vector of frequencies appropriate for the provided data.

References

@@ -143,15 +143,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/generate.html b/dev/reference/generate.html new file mode 100644 index 00000000..1182a598 --- /dev/null +++ b/dev/reference/generate.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/generate.mdl_df.html b/dev/reference/generate.mdl_df.html index 2b05fe30..6cd9f93c 100644 --- a/dev/reference/generate.mdl_df.html +++ b/dev/reference/generate.mdl_df.html @@ -5,7 +5,7 @@ - +
- +

Generate responses from a mable

- Source: R/generate.R + Source: R/generate.R
@@ -67,10 +67,10 @@

Generate responses from a mable

- 
# S3 method for mdl_df
+    
# S3 method for class 'mdl_df'
 generate(x, new_data = NULL, h = NULL, times = 1, seed = NULL, ...)
 
-# S3 method for mdl_ts
+# S3 method for class 'mdl_ts'
 generate(
   x,
   new_data = NULL,
@@ -85,36 +85,38 @@ 
Generate responses from a mable

 
     

     
Arguments

-    
x

+
+
+
x

 
A mable.

 
 
-
new_data

+
new_data

 
The data to be generated (time index and exogenous regressors)

 
 
-
h

+
h

 
The simulation horizon (can be used instead of new_data for regular
 time series with no exogenous regressors).

 
 
-
times

+
times

 
The number of replications.

 
 
-
seed

+
seed

 
The seed for the random generation from distributions.

 
 
-
...

+
...

 
Additional arguments for individual simulation methods.

 
 
-
bootstrap

+
bootstrap

 
If TRUE, then forecast distributions are computed using simulation with resampled errors.

 
 
-
bootstrap_block_size

+
bootstrap_block_size

 
The bootstrap block size specifies the number of contiguous residuals to be taken in each bootstrap sample.

 
 

@@ -163,15 +165,15 @@ 
Examples

 

 
 

-  
Site built with pkgdown 2.0.9.

+  
Site built with pkgdown 2.1.0.
- - + + diff --git a/dev/reference/generate.mdl_ts.html b/dev/reference/generate.mdl_ts.html new file mode 100644 index 00000000..5baf3468 --- /dev/null +++ b/dev/reference/generate.mdl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/get_frequencies.NULL.html b/dev/reference/get_frequencies.NULL.html new file mode 100644 index 00000000..9a69f88f --- /dev/null +++ b/dev/reference/get_frequencies.NULL.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/get_frequencies.Period.html b/dev/reference/get_frequencies.Period.html new file mode 100644 index 00000000..9a69f88f --- /dev/null +++ b/dev/reference/get_frequencies.Period.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/get_frequencies.character.html b/dev/reference/get_frequencies.character.html new file mode 100644 index 00000000..9a69f88f --- /dev/null +++ b/dev/reference/get_frequencies.character.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/get_frequencies.html b/dev/reference/get_frequencies.html new file mode 100644 index 00000000..9a69f88f --- /dev/null +++ b/dev/reference/get_frequencies.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/get_frequencies.numeric.html b/dev/reference/get_frequencies.numeric.html new file mode 100644 index 00000000..9a69f88f --- /dev/null +++ b/dev/reference/get_frequencies.numeric.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/glance.html b/dev/reference/glance.html index a17aba98..e791c7d1 100644 --- a/dev/reference/glance.html +++ b/dev/reference/glance.html @@ -6,7 +6,7 @@ - +
- +

Glance a mable

- Source: R/broom.R + Source: R/broom.R
@@ -69,20 +69,22 @@

Glance a mable

- 
# S3 method for mdl_df
+    
# S3 method for class 'mdl_df'
 glance(x, ...)
 
-# S3 method for mdl_ts
+# S3 method for class 'mdl_ts'
 glance(x, ...)

Arguments

-
x
+ + +
x

A mable.

-
...
+
...

Arguments for model methods.

@@ -128,15 +130,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/glance.mdl_ts.html b/dev/reference/glance.mdl_ts.html new file mode 100644 index 00000000..90fd1cfd --- /dev/null +++ b/dev/reference/glance.mdl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/hfitted.html b/dev/reference/hfitted.html new file mode 100644 index 00000000..fa97d965 --- /dev/null +++ b/dev/reference/hfitted.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/hilo.html b/dev/reference/hilo.html new file mode 100644 index 00000000..1182a598 --- /dev/null +++ b/dev/reference/hilo.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/hypothesize.html b/dev/reference/hypothesize.html new file mode 100644 index 00000000..1182a598 --- /dev/null +++ b/dev/reference/hypothesize.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/hypothesize.mdl_df.html b/dev/reference/hypothesize.mdl_df.html index 92e2e095..c945a54c 100644 --- a/dev/reference/hypothesize.mdl_df.html +++ b/dev/reference/hypothesize.mdl_df.html @@ -4,7 +4,7 @@ - +
- +

Run a hypothesis test from a mable

- Source: R/hypothesise.R + Source: R/hypothesise.R
@@ -65,24 +65,26 @@

Run a hypothesis test from a mable

- 
# S3 method for mdl_df
+    
# S3 method for class 'mdl_df'
 hypothesize(x, ...)
 
-# S3 method for mdl_ts
+# S3 method for class 'mdl_ts'
 hypothesize(x, tests = list(), ...)

Arguments

-
x
+ + +
x

A mable.

-
...
+
...

Arguments for model methods.

-
tests
+
tests

a list of test functions to perform on the model

@@ -111,15 +113,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/hypothesize.mdl_ts.html b/dev/reference/hypothesize.mdl_ts.html new file mode 100644 index 00000000..6cbac928 --- /dev/null +++ b/dev/reference/hypothesize.mdl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/index.html b/dev/reference/index.html index edd35721..7e526383 100644 --- a/dev/reference/index.html +++ b/dev/reference/index.html @@ -1,9 +1,9 @@ -Function reference • fabletoolsPackage index • fabletools - +
- +
@@ -389,15 +389,15 @@

Extension package helpers -

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/interpolate.html b/dev/reference/interpolate.html index d445bf8d..f8ad81b4 100644 --- a/dev/reference/interpolate.html +++ b/dev/reference/interpolate.html @@ -3,7 +3,7 @@ - +
- +

Interpolate missing values

- Source: R/interpolate.R + Source: R/interpolate.R
@@ -63,24 +63,26 @@

Interpolate missing values

- 
# S3 method for mdl_df
+    
# S3 method for class 'mdl_df'
 interpolate(object, new_data, ...)
 
-# S3 method for mdl_ts
+# S3 method for class 'mdl_ts'
 interpolate(object, new_data, ...)

Arguments

-
object
+ + +
object

A mable containing a single model column.

-
new_data
+
new_data

A dataset with the same structure as the data used to fit the model.

-
...
+
...

Other arguments passed to interpolate methods.

@@ -141,15 +143,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/interpolate.mdl_ts.html b/dev/reference/interpolate.mdl_ts.html new file mode 100644 index 00000000..04dc67c2 --- /dev/null +++ b/dev/reference/interpolate.mdl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/interval_accuracy_measures.html b/dev/reference/interval_accuracy_measures.html index 6e00b968..75bc6be1 100644 --- a/dev/reference/interval_accuracy_measures.html +++ b/dev/reference/interval_accuracy_measures.html @@ -3,7 +3,7 @@ - +
- +

Interval estimate accuracy measures

- Source: R/accuracy.R + Source: R/accuracy.R
@@ -89,46 +89,48 @@

Format

Arguments

-
.dist
+ + +
.dist

The distribution of fitted values from the model, or forecasted values from the forecast.

-
.actual
+
.actual

A vector of responses matching the fitted values (for forecast accuracy, new_data must be provided).

-
level
+
level

The level of the forecast interval.

-
na.rm
+
na.rm

Remove the missing values before calculating the accuracy measure

-
...
+
...

Additional arguments for each measure.

-
.train
+
.train

A vector of responses used to train the model (for forecast accuracy, the orig_data must be provided).

-
demean
+
demean

Should the response be demeaned (MASE)

-
.period
+
.period

The seasonal period of the data (defaulting to 'smallest' seasonal period). from a model, or forecasted values from the forecast.

-
d
+
d

Should the response model include a first difference?

-
D
+
D

Should the response model include a seasonal difference?

@@ -145,15 +147,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/inv_box_cox.html b/dev/reference/inv_box_cox.html new file mode 100644 index 00000000..fe8273fb --- /dev/null +++ b/dev/reference/inv_box_cox.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/invert_transformation.html b/dev/reference/invert_transformation.html new file mode 100644 index 00000000..3cb45d57 --- /dev/null +++ b/dev/reference/invert_transformation.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/is_aggregated.html b/dev/reference/is_aggregated.html index dc3fff65..0cad64eb 100644 --- a/dev/reference/is_aggregated.html +++ b/dev/reference/is_aggregated.html @@ -3,7 +3,7 @@ - +
- +

Is the element an aggregation of smaller data

- Source: R/aggregate.R + Source: R/aggregate.R
@@ -68,7 +68,9 @@

Is the element an aggregation of smaller data

Arguments

-
x
+ + +
x

An object.

@@ -89,15 +91,15 @@

See also

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/is_dable.html b/dev/reference/is_dable.html index 85ef8558..7587d5d4 100644 --- a/dev/reference/is_dable.html +++ b/dev/reference/is_dable.html @@ -3,7 +3,7 @@ - +
- +

Is the object a dable

- Source: R/dable.R + Source: R/dable.R
@@ -68,7 +68,9 @@

Is the object a dable

Arguments

-
x
+ + +
x

An object.

@@ -85,15 +87,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/is_fable.html b/dev/reference/is_fable.html index 9158ab24..211bc3f7 100644 --- a/dev/reference/is_fable.html +++ b/dev/reference/is_fable.html @@ -3,7 +3,7 @@ - +
- +

Is the object a fable

- Source: R/fable.R + Source: R/fable.R
@@ -68,7 +68,9 @@

Is the object a fable

Arguments

-
x
+ + +
x

An object.

@@ -85,15 +87,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/is_mable.html b/dev/reference/is_mable.html index d8a9697e..60e66cfe 100644 --- a/dev/reference/is_mable.html +++ b/dev/reference/is_mable.html @@ -3,7 +3,7 @@ - +
- +

Is the object a mable

- Source: R/mable.R + Source: R/mable.R
@@ -68,7 +68,9 @@

Is the object a mable

Arguments

-
x
+ + +
x

An object.

@@ -85,15 +87,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/is_model.html b/dev/reference/is_model.html index 153d7e52..f587e224 100644 --- a/dev/reference/is_model.html +++ b/dev/reference/is_model.html @@ -3,7 +3,7 @@ - +
- +

Is the object a model

- Source: R/mdl_ts.R + Source: R/mdl_ts.R
@@ -68,7 +68,9 @@

Is the object a model

Arguments

-
x
+ + +
x

An object.

@@ -85,15 +87,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/is_null_model.html b/dev/reference/is_null_model.html new file mode 100644 index 00000000..6b52e7f5 --- /dev/null +++ b/dev/reference/is_null_model.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/mable-vctrs.html b/dev/reference/mable-vctrs.html index 4b380949..0c791071 100644 --- a/dev/reference/mable-vctrs.html +++ b/dev/reference/mable-vctrs.html @@ -4,7 +4,7 @@ - +
- +

Internal vctrs methods

- Source: R/vctrs-mable.R + Source: R/vctrs-mable.R
@@ -65,10 +65,10 @@

Internal vctrs methods

- 
# S3 method for mdl_df
+    
# S3 method for class 'mdl_df'
 vec_ptype2(x, y, ...)
 
-# S3 method for mdl_df
+# S3 method for class 'mdl_df'
 vec_cast(x, to, ...)
@@ -85,15 +85,15 @@

Internal vctrs methods

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/mable.html b/dev/reference/mable.html index c47a9a42..143fc1ec 100644 --- a/dev/reference/mable.html +++ b/dev/reference/mable.html @@ -7,7 +7,7 @@ - +
- +

Create a new mable

- Source: R/mable.R + Source: R/mable.R
@@ -76,7 +76,9 @@

Create a new mable

Arguments

-
...
+ + +
...

<dynamic-dots> A set of name-value pairs. These arguments are processed with rlang::quos() and support unquote via !! and @@ -89,11 +91,11 @@

Arguments

named .data.

-
key
+
key

Structural variable(s) that identify each model.

-
model
+
model

Identifiers for the columns containing model(s).

@@ -110,15 +112,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/mable_vars.html b/dev/reference/mable_vars.html index 2c257aac..10ddeded 100644 --- a/dev/reference/mable_vars.html +++ b/dev/reference/mable_vars.html @@ -4,7 +4,7 @@ - +
- +

Return model column variables

- Source: R/accessors.R + Source: R/accessors.R
@@ -70,7 +70,9 @@

Return model column variables

Arguments

-
x
+ + +
x

A dataset containing models (such as a mable).

@@ -87,15 +89,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/middle_out.html b/dev/reference/middle_out.html index a1c8e5fc..a3a9b164 100644 --- a/dev/reference/middle_out.html +++ b/dev/reference/middle_out.html @@ -3,7 +3,7 @@ - +
- +

Middle out forecast reconciliation

- Source: R/reconciliation.R + Source: R/reconciliation.R
@@ -68,11 +68,13 @@

Middle out forecast reconciliation

Arguments

-
models
+ + +
models

A column of models in a mable.

-
split
+
split

The middle level of the hierarchy from which the bottom-up and top-down approaches are used above and below respectively.

@@ -101,15 +103,15 @@

See also

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/min_trace.html b/dev/reference/min_trace.html index 3e1161d3..bb86b16f 100644 --- a/dev/reference/min_trace.html +++ b/dev/reference/min_trace.html @@ -6,7 +6,7 @@ - +
- +

Minimum trace forecast reconciliation

- Source: R/reconciliation.R + Source: R/reconciliation.R
@@ -78,15 +78,17 @@

Minimum trace forecast reconciliation

Arguments

-
models
+ + +
models

A column of models in a mable.

-
method
+
method

The reconciliation method to use.

-
sparse
+
sparse

If TRUE, the reconciliation will be computed using sparse matrix algebra? By default, sparse matrices will be used if the MatrixM package is installed.

@@ -113,15 +115,15 @@

See also

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/model.html b/dev/reference/model.html index 9d83fc82..e67d920f 100644 --- a/dev/reference/model.html +++ b/dev/reference/model.html @@ -9,7 +9,7 @@ - +
- +

Estimate models

- Source: R/model.R + Source: R/model.R
@@ -77,28 +77,30 @@

Estimate models

model(.data, ...)
 
-# S3 method for tbl_ts
+# S3 method for class 'tbl_ts'
 model(.data, ..., .safely = TRUE)

Arguments

-
.data
+ + +
.data

A data structure suitable for the models (such as a tsibble)

-
...
+
...

Definitions for the models to be used. All models must share the same response variable.

-
.safely
+
.safely

If a model encounters an error, rather than aborting the process a NULL model will be returned instead. This allows for an error to occur when computing many models, without losing the results of the successful models.

Parallel

- +

It is possible to estimate models in parallel using the @@ -108,7 +110,7 @@

Parallel

Progress

- +

Progress on model estimation can be obtained by wrapping the code with @@ -164,15 +166,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/model.tbl_ts.html b/dev/reference/model.tbl_ts.html new file mode 100644 index 00000000..f963492b --- /dev/null +++ b/dev/reference/model.tbl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/model_lhs.html b/dev/reference/model_lhs.html index 1ed013a6..cb449ad6 100644 --- a/dev/reference/model_lhs.html +++ b/dev/reference/model_lhs.html @@ -3,7 +3,7 @@ - +
- +

Extract the left hand side of a model

- Source: R/model.R + Source: R/model.R
@@ -68,7 +68,9 @@

Extract the left hand side of a model

Arguments

-
model
+ + +
model

A formula

@@ -85,15 +87,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/model_rhs.html b/dev/reference/model_rhs.html index 157dc3ff..f0c2f1a3 100644 --- a/dev/reference/model_rhs.html +++ b/dev/reference/model_rhs.html @@ -3,7 +3,7 @@ - +
- +

Extract the right hand side of a model

- Source: R/model.R + Source: R/model.R
@@ -68,7 +68,9 @@

Extract the right hand side of a model

Arguments

-
model
+ + +
model

A formula

@@ -85,15 +87,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/model_sum.html b/dev/reference/model_sum.html index 5f0e7dbc..9c2ddd28 100644 --- a/dev/reference/model_sum.html +++ b/dev/reference/model_sum.html @@ -3,7 +3,7 @@ - +
- +

Provide a succinct summary of a model

- Source: R/mdl_ts.R + Source: R/mdl_ts.R
@@ -68,7 +68,9 @@

Provide a succinct summary of a model

Arguments

-
x
+ + +
x

The model to summarise

@@ -85,15 +87,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/new-model-class.html b/dev/reference/new-model-class.html index 1a1bf12b..eadfa3dd 100644 --- a/dev/reference/new-model-class.html +++ b/dev/reference/new-model-class.html @@ -3,7 +3,7 @@ - +
- +

Create a new class of models

- Source: R/definitions.R + Source: R/definitions.R
@@ -82,35 +82,37 @@

Create a new class of models

Arguments

-
model
+ + +
model

The name of the model

-
train
+
train

A function that trains the model to a dataset. .data is a tsibble containing the data's index and response variables only. formula is the user's provided formula. specials is the evaluated specials used in the formula.

-
specials
+
specials

Special functions produced using new_specials()

-
check
+
check

A function that is used to check the data for suitability with the model. This can be used to check for missing values (both implicit and explicit), regularity of observations, ordered time index, and univariate responses.

-
prepare
+
prepare

This allows you to modify the model class according to user inputs. ... is the arguments passed to new_model_definition, allowing you to perform different checks or training procedures according to different user inputs.

-
...
+
...

Further arguments to R6::R6Class(). This can be useful to set up additional elements used in the other functions. For example, to use common_xregs, an origin element in the model is used to store @@ -118,19 +120,19 @@

Arguments

must add an origin element to the object (say with origin = NULL).

-
.env
+
.env

The environment from which functions should inherit from.

-
.inherit
+
.inherit

A model class to inherit from.

-
.class
+
.class

A model class (typically created with new_model_class()).

-
formula
+
formula

The user's model formula.

@@ -155,15 +157,15 @@

Details

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/new_model_definition.html b/dev/reference/new_model_definition.html new file mode 100644 index 00000000..b82adb71 --- /dev/null +++ b/dev/reference/new_model_definition.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/new_specials.html b/dev/reference/new_specials.html index 2cbfa6f1..789bc123 100644 --- a/dev/reference/new_specials.html +++ b/dev/reference/new_specials.html @@ -3,7 +3,7 @@ - +
- +

Create evaluation environment for specials

- Source: R/specials.R + Source: R/specials.R
@@ -68,15 +68,17 @@

Create evaluation environment for specials

Arguments

-
...
+ + +
...

A named set of functions which used to parse formula inputs

-
.required_specials
+
.required_specials

The names of specials which must be provided (and if not, are included with no inputs).

-
.xreg_specials
+
.xreg_specials

The names of specials which will be only used as inputs to other specials (most commonly xreg).

@@ -93,15 +95,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/new_transformation.html b/dev/reference/new_transformation.html index 7181963a..b73eff8f 100644 --- a/dev/reference/new_transformation.html +++ b/dev/reference/new_transformation.html @@ -3,7 +3,7 @@ - +
- +

Create a new modelling transformation

- Source: R/transform.R + Source: R/transform.R
@@ -70,19 +70,21 @@

Create a new modelling transformation

Arguments

-
transformation
+ + +
transformation

A function which transforms the data

-
inverse
+
inverse

A function which is the inverse of a transformation

-
x
+
x

A transformation (such as one created with new_transformation).

-
...
+
...

Further arguments passed to other methods.

@@ -122,15 +124,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/null_model.html b/dev/reference/null_model.html index 4d0a0474..85612722 100644 --- a/dev/reference/null_model.html +++ b/dev/reference/null_model.html @@ -5,7 +5,7 @@ - +
- +

NULL model

- Source: R/model_null.R + Source: R/model_null.R
@@ -74,15 +74,17 @@

NULL model

Arguments

-
formula
+ + +
formula

Model specification (response variable)

-
...
+
...

Unused

-
x
+
x

The object to be tested.

@@ -99,15 +101,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/outliers.html b/dev/reference/outliers.html index 723fcb95..349cfb31 100644 --- a/dev/reference/outliers.html +++ b/dev/reference/outliers.html @@ -3,7 +3,7 @@ - +
- +

Identify outliers

- Source: R/outliers.R + Source: R/outliers.R
@@ -65,20 +65,22 @@

Identify outliers

outliers(object, ...)
 
-# S3 method for mdl_df
+# S3 method for class 'mdl_df'
 outliers(object, ...)
 
-# S3 method for mdl_ts
+# S3 method for class 'mdl_ts'
 outliers(object, ...)

Arguments

-
object
+ + +
object

An object which can identify outliers.

-
...
+
...

Arguments for further methods.

@@ -95,15 +97,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/outliers.mdl_df.html b/dev/reference/outliers.mdl_df.html new file mode 100644 index 00000000..87ac8b0b --- /dev/null +++ b/dev/reference/outliers.mdl_df.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/outliers.mdl_ts.html b/dev/reference/outliers.mdl_ts.html new file mode 100644 index 00000000..87ac8b0b --- /dev/null +++ b/dev/reference/outliers.mdl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/parse_model.html b/dev/reference/parse_model.html index f1e4f15c..9c2ab5bc 100644 --- a/dev/reference/parse_model.html +++ b/dev/reference/parse_model.html @@ -4,7 +4,7 @@ - +
- +

Parse the model specification for specials

- Source: R/parse.R + Source: R/parse.R
@@ -70,7 +70,9 @@

Parse the model specification for specials

Arguments

-
model
+ + +
model

A model definition

@@ -87,15 +89,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/parse_model_lhs.html b/dev/reference/parse_model_lhs.html index f98ebf62..be8918b1 100644 --- a/dev/reference/parse_model_lhs.html +++ b/dev/reference/parse_model_lhs.html @@ -3,7 +3,7 @@ - +
- +

Parse the RHS of the model formula for transformations

- Source: R/parse.R + Source: R/parse.R
@@ -68,7 +68,9 @@

Parse the RHS of the model formula for transformations

Arguments

-
model
+ + +
model

A model definition

@@ -85,15 +87,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/parse_model_rhs.html b/dev/reference/parse_model_rhs.html index 031517c5..1e984376 100644 --- a/dev/reference/parse_model_rhs.html +++ b/dev/reference/parse_model_rhs.html @@ -3,7 +3,7 @@ - +
- +

Parse the RHS of the model formula for specials

- Source: R/parse.R + Source: R/parse.R
@@ -68,7 +68,9 @@

Parse the RHS of the model formula for specials

Arguments

-
model
+ + +
model

A model definition

@@ -85,15 +87,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/pinball_loss.html b/dev/reference/pinball_loss.html new file mode 100644 index 00000000..dedc71df --- /dev/null +++ b/dev/reference/pinball_loss.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/point_accuracy_measures.html b/dev/reference/point_accuracy_measures.html index 3144c8bb..13bb3f3d 100644 --- a/dev/reference/point_accuracy_measures.html +++ b/dev/reference/point_accuracy_measures.html @@ -3,7 +3,7 @@ - +
- +

Point estimate accuracy measures

- Source: R/accuracy.R + Source: R/accuracy.R
@@ -108,47 +108,49 @@

Format

Arguments

-
.resid
+ + +
.resid

A vector of residuals from either the training (model accuracy) or test (forecast accuracy) data.

-
na.rm
+
na.rm

Remove the missing values before calculating the accuracy measure

-
...
+
...

Additional arguments for each measure.

-
.actual
+
.actual

A vector of responses matching the fitted values (for forecast accuracy, new_data must be provided).

-
.train
+
.train

A vector of responses used to train the model (for forecast accuracy, the orig_data must be provided).

-
demean
+
demean

Should the response be demeaned (MASE)

-
.period
+
.period

The seasonal period of the data (defaulting to 'smallest' seasonal period). from a model, or forecasted values from the forecast.

-
d
+
d

Should the response model include a first difference?

-
D
+
D

Should the response model include a seasonal difference?

-
na.action
+
na.action

Function to handle missing values.

@@ -165,15 +167,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/quantile_score.html b/dev/reference/quantile_score.html new file mode 100644 index 00000000..428ad9ea --- /dev/null +++ b/dev/reference/quantile_score.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/reconcile.html b/dev/reference/reconcile.html index 4417ebde..2deab3c5 100644 --- a/dev/reference/reconcile.html +++ b/dev/reference/reconcile.html @@ -4,7 +4,7 @@ - +
- +

Forecast reconciliation

- Source: R/reconciliation.R + Source: R/reconciliation.R
@@ -67,17 +67,19 @@

Forecast reconciliation

reconcile(.data, ...)
 
-# S3 method for mdl_df
+# S3 method for class 'mdl_df'
 reconcile(.data, ...)

Arguments

-
.data
+ + +
.data

A mable.

-
...
+
...

Reconciliation methods applied to model columns within .data.

@@ -121,15 +123,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/reconcile.mdl_df.html b/dev/reference/reconcile.mdl_df.html new file mode 100644 index 00000000..05902c97 --- /dev/null +++ b/dev/reference/reconcile.mdl_df.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/reexports.html b/dev/reference/reexports.html index 4ad19955..a36bd9dd 100644 --- a/dev/reference/reexports.html +++ b/dev/reference/reexports.html @@ -26,7 +26,7 @@ - +
- +

Objects exported from other packages

- Source: R/reexports.R + Source: R/reexports.R
@@ -120,15 +120,15 @@

Objects exported from other packages

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/refit.html b/dev/reference/refit.html index 5253f9ab..3d66b72e 100644 --- a/dev/reference/refit.html +++ b/dev/reference/refit.html @@ -4,7 +4,7 @@ - +
- +

Refit a mable to a new dataset

- Source: R/refit.R + Source: R/refit.R
@@ -65,24 +65,26 @@

Refit a mable to a new dataset

- 
# S3 method for mdl_df
+    
# S3 method for class 'mdl_df'
 refit(object, new_data, ...)
 
-# S3 method for mdl_ts
+# S3 method for class 'mdl_ts'
 refit(object, new_data, ...)

Arguments

-
object
+ + +
object

A mable.

-
new_data
+
new_data

A tsibble dataset used to refit the model.

-
...
+
...

Additional optional arguments for refit methods.

@@ -146,15 +148,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/refit.mdl_ts.html b/dev/reference/refit.mdl_ts.html new file mode 100644 index 00000000..88a90783 --- /dev/null +++ b/dev/reference/refit.mdl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/register_feature.html b/dev/reference/register_feature.html index 87540d8a..6d0014e2 100644 --- a/dev/reference/register_feature.html +++ b/dev/reference/register_feature.html @@ -5,7 +5,7 @@ - +
- +

Register a feature function

- Source: R/features.R + Source: R/features.R
@@ -72,11 +72,13 @@

Register a feature function

Arguments

-
fn
+ + +
fn

The feature function

-
tags
+
tags

Identifying tags

@@ -84,14 +86,14 @@

Arguments

Examples


-if (FALSE) {
+if (FALSE) { # \dontrun{
 tukey_five <- function(x){
   setNames(fivenum(x), c("min", "hinge_lwr", "med", "hinge_upr", "max"))
 }
 
 register_feature(tukey_five, tags = c("boxplot", "simple"))
 
-}
+} # }
@@ -107,15 +109,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/report.html b/dev/reference/report.html index cda8369a..31901eb9 100644 --- a/dev/reference/report.html +++ b/dev/reference/report.html @@ -3,7 +3,7 @@ - +
- +

Report information about an object

- Source: R/report.R + Source: R/report.R
@@ -68,11 +68,13 @@

Report information about an object

Arguments

-
object
+ + +
object

The object to report

-
...
+
...

Additional options for the reporting function

@@ -89,15 +91,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/residuals.mdl_df.html b/dev/reference/residuals.mdl_df.html index b339a3e4..92268f69 100644 --- a/dev/reference/residuals.mdl_df.html +++ b/dev/reference/residuals.mdl_df.html @@ -4,7 +4,7 @@ - +
- +

Extract residuals values from models

- Source: R/residuals.R + Source: R/residuals.R
@@ -65,24 +65,26 @@

Extract residuals values from models

- 
# S3 method for mdl_df
+    
# S3 method for class 'mdl_df'
 residuals(object, ...)
 
-# S3 method for mdl_ts
+# S3 method for class 'mdl_ts'
 residuals(object, type = "innovation", ...)

Arguments

-
object
+ + +
object

A mable or time series model.

-
...
+
...

Other arguments passed to the model method for residuals()

-
type
+
type

The type of residuals to compute. If type="response", residuals on the back-transformed data will be computed.

@@ -99,15 +101,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/residuals.mdl_ts.html b/dev/reference/residuals.mdl_ts.html new file mode 100644 index 00000000..1dfc470d --- /dev/null +++ b/dev/reference/residuals.mdl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/response.html b/dev/reference/response.html index 238a5832..396c8788 100644 --- a/dev/reference/response.html +++ b/dev/reference/response.html @@ -4,7 +4,7 @@ - +
- +

Extract the response variable from a model

- Source: R/response.R + Source: R/response.R
@@ -70,11 +70,13 @@

Extract the response variable from a model

Arguments

-
object
+ + +
object

The object containing response data

-
...
+
...

Additional parameters passed on to other methods

@@ -91,15 +93,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/response_vars.html b/dev/reference/response_vars.html index 23b7aec0..d8533c86 100644 --- a/dev/reference/response_vars.html +++ b/dev/reference/response_vars.html @@ -4,7 +4,7 @@ - +
- +

Return response variables

- Source: R/accessors.R + Source: R/accessors.R
@@ -70,7 +70,9 @@

Return response variables

Arguments

-
x
+ + +
x

A dataset containing a response variable (such as a mable, fable, or dable).

@@ -87,15 +89,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/scaled_pinball_loss.html b/dev/reference/scaled_pinball_loss.html new file mode 100644 index 00000000..dedc71df --- /dev/null +++ b/dev/reference/scaled_pinball_loss.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/scenarios.html b/dev/reference/scenarios.html index 4d4e8f56..2c5cc000 100644 --- a/dev/reference/scenarios.html +++ b/dev/reference/scenarios.html @@ -3,7 +3,7 @@ - +
- +

A set of future scenarios for forecasting

- Source: R/forecast.R + Source: R/forecast.R
@@ -68,11 +68,13 @@

A set of future scenarios for forecasting

Arguments

-
...
+ + +
...

Input data for each scenario

-
names_to
+
names_to

The column name used to identify each scenario

@@ -89,15 +91,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/skill_score.html b/dev/reference/skill_score.html index f46298c7..4d286290 100644 --- a/dev/reference/skill_score.html +++ b/dev/reference/skill_score.html @@ -8,7 +8,7 @@ - +
- +

Forecast skill score measure

- Source: R/accuracy.R + Source: R/accuracy.R
@@ -78,7 +78,9 @@

Forecast skill score measure

Arguments

-
measure
+ + +
measure

The accuracy measure to use in computing the skill score.

@@ -107,8 +109,8 @@

Examples

#> ref_score <- do.call(measure, bench) #> 1 - score/ref_score #> } -#> <bytecode: 0x55cc86faeab8> -#> <environment: 0x55cc86fb30a0> +#> <bytecode: 0x564187d2e4a0> +#> <environment: 0x564187d349a8> library(fable) library(tsibble) @@ -143,15 +145,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/special_xreg.html b/dev/reference/special_xreg.html index ab11d9e6..ada75632 100644 --- a/dev/reference/special_xreg.html +++ b/dev/reference/special_xreg.html @@ -3,7 +3,7 @@ - +
- +

Helper special for producing a model matrix of exogenous regressors

- Source: R/specials.R + Source: R/specials.R
@@ -68,7 +68,9 @@

Helper special for producing a model matrix of exogenous regressors

Arguments

-
...
+ + +
...

Arguments for fable_xreg_matrix (see Details)

@@ -93,15 +95,15 @@

Details

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/stream.html b/dev/reference/stream.html index afb0486a..63091962 100644 --- a/dev/reference/stream.html +++ b/dev/reference/stream.html @@ -4,7 +4,7 @@ - +
- +

Extend a fitted model with new data

- Source: R/stream.R + Source: R/stream.R
@@ -67,21 +67,23 @@

Extend a fitted model with new data

stream(object, ...)
 
-# S3 method for mdl_df
+# S3 method for class 'mdl_df'
 stream(object, new_data, ...)

Arguments

-
object
+ + +
object

An object (such as a model) which can be extended with additional data.

-
...
+
...

Additional arguments passed on to stream methods.

-
new_data
+
new_data

A dataset of the same structure as was used to fit the model.

@@ -98,15 +100,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/stream.mdl_df.html b/dev/reference/stream.mdl_df.html new file mode 100644 index 00000000..62a3792d --- /dev/null +++ b/dev/reference/stream.mdl_df.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/tidy.html b/dev/reference/tidy.html index 36ebf9cb..d4afa8b0 100644 --- a/dev/reference/tidy.html +++ b/dev/reference/tidy.html @@ -4,7 +4,7 @@ - +
- +

Extract model coefficients from a mable

- Source: R/broom.R + Source: R/broom.R
@@ -65,26 +65,28 @@

Extract model coefficients from a mable

- 
# S3 method for mdl_df
+    
# S3 method for class 'mdl_df'
 tidy(x, ...)
 
-# S3 method for mdl_df
+# S3 method for class 'mdl_df'
 coef(object, ...)
 
-# S3 method for mdl_ts
+# S3 method for class 'mdl_ts'
 tidy(x, ...)
 
-# S3 method for mdl_ts
+# S3 method for class 'mdl_ts'
 coef(object, ...)

Arguments

-
x, object
+ + +
x, object

A mable.

-
...
+
...

Arguments for model methods.

@@ -125,15 +127,15 @@

Examples

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/tidy.mdl_ts.html b/dev/reference/tidy.mdl_ts.html new file mode 100644 index 00000000..a32634e0 --- /dev/null +++ b/dev/reference/tidy.mdl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/top_down.html b/dev/reference/top_down.html index 61a61c11..4257572c 100644 --- a/dev/reference/top_down.html +++ b/dev/reference/top_down.html @@ -3,7 +3,7 @@ - +
- +

Top down forecast reconciliation

- Source: R/reconciliation.R + Source: R/reconciliation.R
@@ -71,11 +71,13 @@

Top down forecast reconciliation

Arguments

-
models
+ + +
models

A column of models in a mable.

-
method
+
method

The reconciliation method to use.

@@ -102,15 +104,15 @@

See also

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/traverse.html b/dev/reference/traverse.html index cdce58ba..7da1b7ba 100644 --- a/dev/reference/traverse.html +++ b/dev/reference/traverse.html @@ -3,7 +3,7 @@ - +
- +

Recursively traverse an object

- Source: R/traverse.R + Source: R/traverse.R
@@ -74,23 +74,25 @@

Recursively traverse an object

Arguments

-
x
+ + +
x

The object to traverse

-
.f
+
.f

A function for combining the recursed components

-
.g
+
.g

A function applied to the object before recursion

-
.h
+
.h

A function applied to the base case

-
base
+
base

The base case for the recursion

@@ -107,15 +109,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/unpack_hilo.html b/dev/reference/unpack_hilo.html index a6481b33..93fb56d3 100644 --- a/dev/reference/unpack_hilo.html +++ b/dev/reference/unpack_hilo.html @@ -9,7 +9,7 @@ - +
- +

Unpack a hilo column

- Source: R/hilo.R + Source: R/hilo.R
@@ -80,15 +80,17 @@

Unpack a hilo column

Arguments

-
data
+ + +
data

A data frame.

-
cols
+
cols

Name of hilo columns to unpack.

-
names_sep
+
names_sep

If NULL, the default, the names will be left as is. In pack(), inner names will come from the former outer names; in unpack(), the new outer names will come from the inner names.

@@ -100,7 +102,7 @@

Arguments

packing and unpacking.

-
names_repair
+
names_repair

Used to check that output data frame has valid names. Must be one of the following options:

  • "minimal": no name repair or checks, beyond basic existence,

  • "unique": make sure names are unique and not empty,

    • @@ -130,15 +132,15 @@

    See also

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/validate_formula.html b/dev/reference/validate_formula.html index 6714e4c3..c34b1167 100644 --- a/dev/reference/validate_formula.html +++ b/dev/reference/validate_formula.html @@ -4,7 +4,7 @@ - +
- +

Validate the user provided model

- Source: R/parse.R + Source: R/parse.R
@@ -70,11 +70,13 @@

Validate the user provided model

Arguments

-
model
+ + +
model

A quosure for the user's model specification

-
data
+
data

A dataset used for automatic response selection

@@ -91,15 +93,15 @@

Arguments

-

Site built with pkgdown 2.0.9.

+

Site built with pkgdown 2.1.0.

- - + + diff --git a/dev/reference/vars.html b/dev/reference/vars.html new file mode 100644 index 00000000..1182a598 --- /dev/null +++ b/dev/reference/vars.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/vec_cast.agg_vec.agg_vec.html b/dev/reference/vec_cast.agg_vec.agg_vec.html new file mode 100644 index 00000000..055e92e7 --- /dev/null +++ b/dev/reference/vec_cast.agg_vec.agg_vec.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/vec_cast.agg_vec.default.html b/dev/reference/vec_cast.agg_vec.default.html new file mode 100644 index 00000000..055e92e7 --- /dev/null +++ b/dev/reference/vec_cast.agg_vec.default.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/vec_cast.agg_vec.html b/dev/reference/vec_cast.agg_vec.html new file mode 100644 index 00000000..055e92e7 --- /dev/null +++ b/dev/reference/vec_cast.agg_vec.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/vec_cast.character.agg_vec.html b/dev/reference/vec_cast.character.agg_vec.html new file mode 100644 index 00000000..055e92e7 --- /dev/null +++ b/dev/reference/vec_cast.character.agg_vec.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/vec_cast.dcmp_ts.html b/dev/reference/vec_cast.dcmp_ts.html new file mode 100644 index 00000000..9398e20f --- /dev/null +++ b/dev/reference/vec_cast.dcmp_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/vec_cast.fbl_ts.html b/dev/reference/vec_cast.fbl_ts.html new file mode 100644 index 00000000..fe16ff3c --- /dev/null +++ b/dev/reference/vec_cast.fbl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/vec_cast.mdl_df.html b/dev/reference/vec_cast.mdl_df.html new file mode 100644 index 00000000..2009a8db --- /dev/null +++ b/dev/reference/vec_cast.mdl_df.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/vec_proxy_compare.agg_vec.html b/dev/reference/vec_proxy_compare.agg_vec.html new file mode 100644 index 00000000..055e92e7 --- /dev/null +++ b/dev/reference/vec_proxy_compare.agg_vec.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/vec_ptype2.agg_vec.agg_vec.html b/dev/reference/vec_ptype2.agg_vec.agg_vec.html new file mode 100644 index 00000000..055e92e7 --- /dev/null +++ b/dev/reference/vec_ptype2.agg_vec.agg_vec.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/vec_ptype2.agg_vec.character.html b/dev/reference/vec_ptype2.agg_vec.character.html new file mode 100644 index 00000000..055e92e7 --- /dev/null +++ b/dev/reference/vec_ptype2.agg_vec.character.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/vec_ptype2.agg_vec.default.html b/dev/reference/vec_ptype2.agg_vec.default.html new file mode 100644 index 00000000..055e92e7 --- /dev/null +++ b/dev/reference/vec_ptype2.agg_vec.default.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/vec_ptype2.agg_vec.html b/dev/reference/vec_ptype2.agg_vec.html new file mode 100644 index 00000000..055e92e7 --- /dev/null +++ b/dev/reference/vec_ptype2.agg_vec.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/vec_ptype2.character.agg_vec.html b/dev/reference/vec_ptype2.character.agg_vec.html new file mode 100644 index 00000000..055e92e7 --- /dev/null +++ b/dev/reference/vec_ptype2.character.agg_vec.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/vec_ptype2.dcmp_ts.html b/dev/reference/vec_ptype2.dcmp_ts.html new file mode 100644 index 00000000..9398e20f --- /dev/null +++ b/dev/reference/vec_ptype2.dcmp_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/vec_ptype2.fbl_ts.html b/dev/reference/vec_ptype2.fbl_ts.html new file mode 100644 index 00000000..fe16ff3c --- /dev/null +++ b/dev/reference/vec_ptype2.fbl_ts.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/vec_ptype2.mdl_df.html b/dev/reference/vec_ptype2.mdl_df.html new file mode 100644 index 00000000..2009a8db --- /dev/null +++ b/dev/reference/vec_ptype2.mdl_df.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/reference/vec_ptype_abbr.agg_vec.html b/dev/reference/vec_ptype_abbr.agg_vec.html new file mode 100644 index 00000000..055e92e7 --- /dev/null +++ b/dev/reference/vec_ptype_abbr.agg_vec.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/dev/sitemap.xml b/dev/sitemap.xml index bea8d12c..5bc4cdb0 100644 --- a/dev/sitemap.xml +++ b/dev/sitemap.xml @@ -1,273 +1,93 @@ - - - - https://fabletools.tidyverts.org/articles/extension_models.html - - - https://fabletools.tidyverts.org/articles/index.html - - - https://fabletools.tidyverts.org/authors.html - - - https://fabletools.tidyverts.org/index.html - - - https://fabletools.tidyverts.org/news/index.html - - - https://fabletools.tidyverts.org/reference/MAAPE.html - - - https://fabletools.tidyverts.org/reference/accuracy.html - - - https://fabletools.tidyverts.org/reference/agg_vec.html - - - https://fabletools.tidyverts.org/reference/aggregate_index.html - - - https://fabletools.tidyverts.org/reference/aggregate_key.html - - - https://fabletools.tidyverts.org/reference/aggregation-vctrs.html - - - https://fabletools.tidyverts.org/reference/as-dable.html - - - https://fabletools.tidyverts.org/reference/as-fable.html - - - https://fabletools.tidyverts.org/reference/as_mable.html - - - https://fabletools.tidyverts.org/reference/augment.html - - - https://fabletools.tidyverts.org/reference/autoplot.dcmp_ts.html - - - https://fabletools.tidyverts.org/reference/autoplot.fbl_ts.html - - - https://fabletools.tidyverts.org/reference/autoplot.tbl_ts.html - - - https://fabletools.tidyverts.org/reference/bias_adjust.html - - - https://fabletools.tidyverts.org/reference/bottom_up.html - - - https://fabletools.tidyverts.org/reference/box_cox.html - - - https://fabletools.tidyverts.org/reference/combination_ensemble.html - - - https://fabletools.tidyverts.org/reference/combination_model.html - - - https://fabletools.tidyverts.org/reference/combination_weighted.html - - - https://fabletools.tidyverts.org/reference/common_xregs.html - - - https://fabletools.tidyverts.org/reference/components.html - - - https://fabletools.tidyverts.org/reference/construct_fc.html - - - https://fabletools.tidyverts.org/reference/dable-vctrs.html - - - https://fabletools.tidyverts.org/reference/dable.html - - - https://fabletools.tidyverts.org/reference/decomposition_model.html - - - https://fabletools.tidyverts.org/reference/directional_accuracy_measures.html - - - https://fabletools.tidyverts.org/reference/distribution_accuracy_measures.html - - - https://fabletools.tidyverts.org/reference/distribution_var.html - - - https://fabletools.tidyverts.org/reference/estimate.html - - - https://fabletools.tidyverts.org/reference/fable-vctrs.html - - - https://fabletools.tidyverts.org/reference/fable.html - - - https://fabletools.tidyverts.org/reference/fabletools-package.html - - - https://fabletools.tidyverts.org/reference/feature_set.html - - - https://fabletools.tidyverts.org/reference/features.html - - - https://fabletools.tidyverts.org/reference/features_by_pkg.html - - - https://fabletools.tidyverts.org/reference/features_by_tag.html - - - https://fabletools.tidyverts.org/reference/fitted.mdl_df.html - - - https://fabletools.tidyverts.org/reference/forecast.html - - - https://fabletools.tidyverts.org/reference/freq_tools.html - - - https://fabletools.tidyverts.org/reference/generate.mdl_df.html - - - https://fabletools.tidyverts.org/reference/glance.html - - - https://fabletools.tidyverts.org/reference/hypothesize.mdl_df.html - - - https://fabletools.tidyverts.org/reference/index.html - - - https://fabletools.tidyverts.org/reference/interpolate.html - - - https://fabletools.tidyverts.org/reference/interval_accuracy_measures.html - - - https://fabletools.tidyverts.org/reference/is_aggregated.html - - - https://fabletools.tidyverts.org/reference/is_dable.html - - - https://fabletools.tidyverts.org/reference/is_fable.html - - - https://fabletools.tidyverts.org/reference/is_mable.html - - - https://fabletools.tidyverts.org/reference/is_model.html - - - https://fabletools.tidyverts.org/reference/mable-vctrs.html - - - https://fabletools.tidyverts.org/reference/mable.html - - - https://fabletools.tidyverts.org/reference/mable_vars.html - - - https://fabletools.tidyverts.org/reference/middle_out.html - - - https://fabletools.tidyverts.org/reference/min_trace.html - - - https://fabletools.tidyverts.org/reference/model.html - - - https://fabletools.tidyverts.org/reference/model_lhs.html - - - https://fabletools.tidyverts.org/reference/model_rhs.html - - - https://fabletools.tidyverts.org/reference/model_sum.html - - - https://fabletools.tidyverts.org/reference/new-model-class.html - - - https://fabletools.tidyverts.org/reference/new_specials.html - - - https://fabletools.tidyverts.org/reference/new_transformation.html - - - https://fabletools.tidyverts.org/reference/null_model.html - - - https://fabletools.tidyverts.org/reference/outliers.html - - - https://fabletools.tidyverts.org/reference/parse_model.html - - - https://fabletools.tidyverts.org/reference/parse_model_lhs.html - - - https://fabletools.tidyverts.org/reference/parse_model_rhs.html - - - https://fabletools.tidyverts.org/reference/point_accuracy_measures.html - - - https://fabletools.tidyverts.org/reference/reconcile.html - - - https://fabletools.tidyverts.org/reference/reexports.html - - - https://fabletools.tidyverts.org/reference/refit.html - - - https://fabletools.tidyverts.org/reference/register_feature.html - - - https://fabletools.tidyverts.org/reference/report.html - - - https://fabletools.tidyverts.org/reference/residuals.mdl_df.html - - - https://fabletools.tidyverts.org/reference/response.html - - - https://fabletools.tidyverts.org/reference/response_vars.html - - - https://fabletools.tidyverts.org/reference/scenarios.html - - - https://fabletools.tidyverts.org/reference/skill_score.html - - - https://fabletools.tidyverts.org/reference/special_xreg.html - - - https://fabletools.tidyverts.org/reference/stream.html - - - https://fabletools.tidyverts.org/reference/tidy.html - - - https://fabletools.tidyverts.org/reference/top_down.html - - - https://fabletools.tidyverts.org/reference/traverse.html - - - https://fabletools.tidyverts.org/reference/unpack_hilo.html - - - https://fabletools.tidyverts.org/reference/validate_formula.html - + +https://fabletools.tidyverts.org/articles/extension_models.html +https://fabletools.tidyverts.org/articles/index.html +https://fabletools.tidyverts.org/authors.html +https://fabletools.tidyverts.org/index.html +https://fabletools.tidyverts.org/news/index.html +https://fabletools.tidyverts.org/reference/MAAPE.html +https://fabletools.tidyverts.org/reference/accuracy.html +https://fabletools.tidyverts.org/reference/agg_vec.html +https://fabletools.tidyverts.org/reference/aggregate_index.html +https://fabletools.tidyverts.org/reference/aggregate_key.html +https://fabletools.tidyverts.org/reference/aggregation-vctrs.html +https://fabletools.tidyverts.org/reference/as-dable.html +https://fabletools.tidyverts.org/reference/as-fable.html +https://fabletools.tidyverts.org/reference/as_mable.html +https://fabletools.tidyverts.org/reference/augment.html +https://fabletools.tidyverts.org/reference/autoplot.dcmp_ts.html +https://fabletools.tidyverts.org/reference/autoplot.fbl_ts.html +https://fabletools.tidyverts.org/reference/autoplot.tbl_ts.html +https://fabletools.tidyverts.org/reference/bias_adjust.html +https://fabletools.tidyverts.org/reference/bottom_up.html +https://fabletools.tidyverts.org/reference/box_cox.html +https://fabletools.tidyverts.org/reference/combination_ensemble.html +https://fabletools.tidyverts.org/reference/combination_model.html +https://fabletools.tidyverts.org/reference/combination_weighted.html +https://fabletools.tidyverts.org/reference/common_xregs.html +https://fabletools.tidyverts.org/reference/components.html +https://fabletools.tidyverts.org/reference/construct_fc.html +https://fabletools.tidyverts.org/reference/dable-vctrs.html +https://fabletools.tidyverts.org/reference/dable.html +https://fabletools.tidyverts.org/reference/decomposition_model.html +https://fabletools.tidyverts.org/reference/directional_accuracy_measures.html +https://fabletools.tidyverts.org/reference/distribution_accuracy_measures.html +https://fabletools.tidyverts.org/reference/distribution_var.html +https://fabletools.tidyverts.org/reference/estimate.html +https://fabletools.tidyverts.org/reference/fable-vctrs.html +https://fabletools.tidyverts.org/reference/fable.html +https://fabletools.tidyverts.org/reference/fabletools-package.html +https://fabletools.tidyverts.org/reference/feature_set.html +https://fabletools.tidyverts.org/reference/features.html +https://fabletools.tidyverts.org/reference/features_by_pkg.html +https://fabletools.tidyverts.org/reference/features_by_tag.html +https://fabletools.tidyverts.org/reference/fitted.mdl_df.html +https://fabletools.tidyverts.org/reference/forecast.html +https://fabletools.tidyverts.org/reference/freq_tools.html +https://fabletools.tidyverts.org/reference/generate.mdl_df.html +https://fabletools.tidyverts.org/reference/glance.html +https://fabletools.tidyverts.org/reference/hypothesize.mdl_df.html +https://fabletools.tidyverts.org/reference/index.html +https://fabletools.tidyverts.org/reference/interpolate.html +https://fabletools.tidyverts.org/reference/interval_accuracy_measures.html +https://fabletools.tidyverts.org/reference/is_aggregated.html +https://fabletools.tidyverts.org/reference/is_dable.html +https://fabletools.tidyverts.org/reference/is_fable.html +https://fabletools.tidyverts.org/reference/is_mable.html +https://fabletools.tidyverts.org/reference/is_model.html +https://fabletools.tidyverts.org/reference/mable-vctrs.html +https://fabletools.tidyverts.org/reference/mable.html +https://fabletools.tidyverts.org/reference/mable_vars.html +https://fabletools.tidyverts.org/reference/middle_out.html +https://fabletools.tidyverts.org/reference/min_trace.html +https://fabletools.tidyverts.org/reference/model.html +https://fabletools.tidyverts.org/reference/model_lhs.html +https://fabletools.tidyverts.org/reference/model_rhs.html +https://fabletools.tidyverts.org/reference/model_sum.html +https://fabletools.tidyverts.org/reference/new-model-class.html +https://fabletools.tidyverts.org/reference/new_specials.html +https://fabletools.tidyverts.org/reference/new_transformation.html +https://fabletools.tidyverts.org/reference/null_model.html +https://fabletools.tidyverts.org/reference/outliers.html +https://fabletools.tidyverts.org/reference/parse_model.html +https://fabletools.tidyverts.org/reference/parse_model_lhs.html +https://fabletools.tidyverts.org/reference/parse_model_rhs.html +https://fabletools.tidyverts.org/reference/point_accuracy_measures.html +https://fabletools.tidyverts.org/reference/reconcile.html +https://fabletools.tidyverts.org/reference/reexports.html +https://fabletools.tidyverts.org/reference/refit.html +https://fabletools.tidyverts.org/reference/register_feature.html +https://fabletools.tidyverts.org/reference/report.html +https://fabletools.tidyverts.org/reference/residuals.mdl_df.html +https://fabletools.tidyverts.org/reference/response.html +https://fabletools.tidyverts.org/reference/response_vars.html +https://fabletools.tidyverts.org/reference/scenarios.html +https://fabletools.tidyverts.org/reference/skill_score.html +https://fabletools.tidyverts.org/reference/special_xreg.html +https://fabletools.tidyverts.org/reference/stream.html +https://fabletools.tidyverts.org/reference/tidy.html +https://fabletools.tidyverts.org/reference/top_down.html +https://fabletools.tidyverts.org/reference/traverse.html +https://fabletools.tidyverts.org/reference/unpack_hilo.html +https://fabletools.tidyverts.org/reference/validate_formula.html +