fabletools/_pkgdown.yml at main · tidyverts/fabletools · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
url: https://fabletools.tidyverts.org

template:
  params:
    bootswatch: cosmo
  includes:
    in_header: |
      <!-- Privacy-friendly analytics by Plausible -->
      <script async src="https://track.mitchelloharawild.com/js/pa-2cqjELTlQyg2tc3MAngFP.js"></script>
      <script>
        window.plausible=window.plausible||function(){(plausible.q=plausible.q||[]).push(arguments)},plausible.init=plausible.init||function(i){plausible.o=i||{}};
        plausible.init()
      </script>


development:
  mode: auto

authors:
  Rob Hyndman:
    href: http://robjhyndman.com
  Mitchell O'Hara-Wild:
    href: https://mitchelloharawild.com
  Earo Wang:
    href: https://earo.me

reference:
- title: Overview
  desc: >
    Describes the package
  contents:
    - fabletools-package
- title: Data structures
  desc: >
    Data classes for models, forecasts and decompositions.
  contents:
    - mable
    - as_mable
    - is_mable
    - fable
    - as_fable
    - is_fable
    - dable
    - as_dable
    - is_dable
    - mable_vars
    - response_vars
    - distribution_var
- title: Models
  desc: >
    Models which make use of models from other packages, or are useful for programming.
  contents:
    - decomposition_model
    - combination_model
    - combination_ensemble
    - combination_weighted
    - null_model
- title: Forecast reconciliation
  desc: >
    Use reconciliation techniques to ensure that forecasts are coherent with the hierarchical structure of data.
  contents:
    - reconcile
    - min_trace
    - bottom_up
    - middle_out
    - top_down
    - aggregate_key
    - aggregate_index
    - agg_vec
    - is_aggregated
- title: Accuracy evaluation
  desc: >
    Functionality for evaluating model performance
  contents:
    - accuracy.mdl_df
    - ME
    - MSE
    - RMSE
    - MAE
    - MPE
    - MAPE
    - MAAPE
    - MASE
    - ACF1
    - winkler_score
    - percentile_score
    - MDA
    - MDV
    - MDPV
    - skill_score
- title: Methods
  desc: >
    The fabletools package facilitates the handling of key structures for these generics.
  contents:
    - forecast
    - model
    - report
    - stream
    - outliers
    - model_sum
    - forecast.mdl_df
    - generate.mdl_df
    - interpolate.mdl_df
    - refit.mdl_df
    - augment.mdl_df
    - glance.mdl_df
    - tidy.mdl_df
    - components.mdl_df
    - fitted.mdl_df
    - residuals.mdl_df
    - estimate
    - response
    - scenarios
    - IRF
    - hypothesize.mdl_df
    - is_model
- title: Features
  desc: >
    Functions for using and defining features across a dataset.
  contents:
    - features
    - feature_set
    - register_feature
- title: Transformations
  desc: >
    Commonly used transformation functions.
  contents:
    - box_cox
    - inv_box_cox
    - new_transformation
- title: Graphics
  desc: >
    Graphics capabilities in feasts have moved to the [ggtime](https://pkg.mitchelloharawild.com/ggtime) package.

    Please use `library(ggtime)` in your code in order to continue using the `autoplot()` and `autolayer()` functions previously provided by this package.
  contents:
    - autoplot.tbl_ts
    - autolayer.tbl_ts
    - autoplot.fbl_ts
    - autolayer.fbl_ts
    - autoplot.dcmp_ts

- title: Extension package helpers
  desc: >
    Functions provided to help develop extension packages.
  contents:
    - special_xreg
    - new_specials
    - new_model_class
    - model_lhs
    - model_rhs
    - common_periods
    - common_xregs