diff --git a/dev/LICENSE.html b/dev/LICENSE.html index f8025fab..7595b67d 100644 --- a/dev/LICENSE.html +++ b/dev/LICENSE.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -63,6 +63,7 @@

GNU General Public License

+

Version 3, 29 June 2007
Copyright © 2007 Free Software Foundation, Inc. <http://fsf.org/>

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

@@ -81,7 +82,7 @@

Preamble

TERMS AND CONDITIONS

-

0. Definitions

+

0. Definitions

“This License” refers to version 3 of the GNU General Public License.

“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.

“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.

@@ -92,7 +93,7 @@

0. DefinitionsAn interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.

-

1. Source Code

+

1. Source Code

The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.

A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.

The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.

@@ -101,23 +102,23 @@

1. Source CodeThe Corresponding Source for a work in source code form is that same work.

-

2. Basic Permissions

+

2. Basic Permissions

All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.

You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.

Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.

- +

No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.

When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work’s users, your or third parties’ legal rights to forbid circumvention of technological measures.

-

4. Conveying Verbatim Copies

+

4. Conveying Verbatim Copies

You may convey verbatim copies of the Program’s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.

You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.

-

5. Conveying Modified Source Versions

+

5. Conveying Modified Source Versions

You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:

  • a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
  • @@ -130,7 +131,7 @@

    5. Conveying Modified Source Versi

A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation’s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.

-

6. Conveying Non-Source Forms

+

6. Conveying Non-Source Forms

You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:

  • a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
  • @@ -150,7 +151,7 @@

    6. Conveying Non-Source Forms -

    7. Additional Terms

    +

    7. Additional Terms

    “Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.

    When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.

    Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:

    @@ -171,24 +172,24 @@

    7. Additional Terms -

    8. Termination

    +

    8. Termination

    You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).

    However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

    Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

    Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.

-

9. Acceptance Not Required for Having Copies

+

9. Acceptance Not Required for Having Copies

You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.

-

10. Automatic Licensing of Downstream Recipients

+

10. Automatic Licensing of Downstream Recipients

Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.

An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party’s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.

You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.

-

11. Patents

+

11. Patents

A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor’s “contributor version”.

A contributor’s “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.

Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor’s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.

@@ -199,30 +200,30 @@

11. Patents -

12. No Surrender of Others’ Freedom

+

12. No Surrender of Others’ Freedom

If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.

-

13. Use with the GNU Affero General Public License

+

13. Use with the GNU Affero General Public License

Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.

-

14. Revised Versions of this License

+

14. Revised Versions of this License

The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.

If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Program.

Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.

-

15. Disclaimer of Warranty

+

15. Disclaimer of Warranty

THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

-

16. Limitation of Liability

+

16. Limitation of Liability

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

-

17. Interpretation of Sections 15 and 16

+

17. Interpretation of Sections 15 and 16

If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.

END OF TERMS AND CONDITIONS

@@ -231,27 +232,27 @@

17. Interpretation of Sections

How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.

-
<one line to give the program's name and a brief idea of what it does.>
-Copyright (C) 2019 Rob J Hyndman
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
<one line to give the program's name and a brief idea of what it does.>
+Copyright (C) 2019 Rob J Hyndman
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

Also add information on how to contact you by electronic and paper mail.

If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:

-
fable Copyright (C) 2019 Rob J Hyndman
-This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'.
-This is free software, and you are welcome to redistribute it
-under certain conditions; type 'show c' for details.
+
fable Copyright (C) 2019 Rob J Hyndman
+This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'.
+This is free software, and you are welcome to redistribute it
+under certain conditions; type 'show c' for details.

The hypothetical commands show w and show c should show the appropriate parts of the General Public License. Of course, your program’s commands might be different; for a GUI interface, you would use an “about box”.

You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <http://www.gnu.org/licenses/>.

The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <http://www.gnu.org/philosophy/why-not-lgpl.html>.

@@ -273,7 +274,7 @@

How to Apply These Terms

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/articles/fable.html b/dev/articles/fable.html index c54093b1..fe45d1cd 100644 --- a/dev/articles/fable.html +++ b/dev/articles/fable.html @@ -41,7 +41,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -89,7 +89,7 @@ -
+
-

The fable package provides some commonly used univariate and multivariate time series forecasting models which can be used with tidy temporal data in the tsibble format. These models are used within a consistent and tidy modelling framework, allowing several models to be estimated, compared, combined, forecasted and otherwise worked with across many time series.

-

Suppose we wanted to forecast the number of domestic travellers to Melbourne, Australia. In the tsibble::tourism data set, this can be further broken down into 4 reasons of travel: “business”, “holiday”, “visiting friends and relatives” and “other reasons”. The first observation from each series are shown below.

+

The fable package provides some commonly used univariate and +multivariate time series forecasting models which can be used with tidy +temporal data in the tsibble format. These models are used within a +consistent and tidy modelling framework, allowing several models to be +estimated, compared, combined, forecasted and otherwise worked with +across many time series.

+

Suppose we wanted to forecast the number of domestic travellers to +Melbourne, Australia. In the tsibble::tourism data set, +this can be further broken down into 4 reasons of travel: “business”, +“holiday”, “visiting friends and relatives” and “other reasons”. The +first observation from each series are shown below.

 tourism_melb <- tourism %>%
   filter(Region == "Melbourne")
@@ -123,13 +132,30 @@ 

Introduction to fable

#> 2 1998 Q1 Melbourne Victoria Holiday 428. #> 3 1998 Q1 Melbourne Victoria Other 79.9 #> 4 1998 Q1 Melbourne Victoria Visiting 666.
-

The variable that we’d like to estimate is the number of overnight trips (in thousands) represented by the Trips variable. A plot of the data reveals that some trends and weak seasonality are apparent.

+

The variable that we’d like to estimate is the number of overnight +trips (in thousands) represented by the Trips variable. A +plot of the data reveals that some trends and weak seasonality are +apparent.

 tourism_melb %>%
   autoplot(Trips)

-

Two widely used models available in this package are ETS and ARIMA. These models are specified using a compact formula representation (much like cross-sectional linear models using lm()). The response variable (Trips) and any transformations are included on the left, while the model specification is on the right of the formula. When a model is not fully specified (or if the formula’s right side is missing completely), the unspecified components will be chosen automatically.

-

Suppose we think that the ETS model must have an additive trend, and want the other elements to be chosen automatically. This model would be specified using ETS(Trips ~ trend("A")). Similarly, a completely automatic ARIMA model (much like auto.arima() from the forecast package) can be specified using ARIMA(Trips). The model() function is used to estimate these model specifications on a particular dataset, and will return a “mable” (model table).

+

Two widely used models available in this package are ETS and ARIMA. +These models are specified using a compact formula representation (much +like cross-sectional linear models using lm()). The +response variable (Trips) and any transformations are +included on the left, while the model specification is on the right of +the formula. When a model is not fully specified (or if the formula’s +right side is missing completely), the unspecified components will be +chosen automatically.

+

Suppose we think that the ETS model must have an additive trend, and +want the other elements to be chosen automatically. This model would be +specified using ETS(Trips ~ trend("A")). Similarly, a +completely automatic ARIMA model (much like auto.arima() +from the forecast package) can be specified using +ARIMA(Trips). The model() function is used to +estimate these model specifications on a particular dataset, and will +return a “mable” (model table).

 fit <- tourism_melb %>%
   model(
@@ -145,30 +171,43 @@ 

Introduction to fable

#> 2 Melbourne Victoria Holiday <ETS(M,A,A)> <ARIMA(0,1,1) w/ drift> #> 3 Melbourne Victoria Other <ETS(A,A,N)> <ARIMA(0,1,1) w/ drift> #> 4 Melbourne Victoria Visiting <ETS(M,A,A)> <ARIMA(0,1,1)(1,0,2)[4]>
-

A mable contains a row for each time series (uniquely identified by the key variables), and a column for each model specification. A model is contained within the cells of each model column. In the example above we can see that the all four ETS models have an additive trend, and the error and seasonality have been chosen automatically. Similarly, the ARIMA model varies between time series as it has been automatically selected.

-

The coef() or tidy() function is used to extract the coefficients from the models. It’s possible to use select() and other verbs to focus on the coefficients from a particular model.

+

A mable contains a row for each time series (uniquely identified by +the key variables), and a column for each model specification. A model +is contained within the cells of each model column. In the example above +we can see that the all four ETS models have an additive trend, and the +error and seasonality have been chosen automatically. Similarly, the +ARIMA model varies between time series as it has been automatically +selected.

+

The coef() or tidy() function is used to +extract the coefficients from the models. It’s possible to use +select() and other verbs to focus on the coefficients from +a particular model.

 fit %>%
   select(Region, State, Purpose, arima) %>%
   coef()
 #> # A tibble: 13 × 9
-#>    Region    State    Purpose  .model term     estimate std.e…¹ stati…²  p.value
-#>    <chr>     <chr>    <chr>    <chr>  <chr>       <dbl>   <dbl>   <dbl>    <dbl>
-#>  1 Melbourne Victoria Business arima  ma1        -0.555  0.130   -4.28  5.29e- 5
-#>  2 Melbourne Victoria Business arima  ma2        -0.233  0.129   -1.81  7.47e- 2
-#>  3 Melbourne Victoria Business arima  sar1        0.946  0.0634  14.9   1.08e-24
-#>  4 Melbourne Victoria Business arima  sma1       -0.772  0.145   -5.34  8.81e- 7
-#>  5 Melbourne Victoria Business arima  constant    0.192  0.213    0.903 3.69e- 1
-#>  6 Melbourne Victoria Holiday  arima  ma1        -0.931  0.0851 -10.9   1.77e-17
-#>  7 Melbourne Victoria Holiday  arima  constant    3.65   0.571    6.39  1.06e- 8
-#>  8 Melbourne Victoria Other    arima  ma1        -0.750  0.0708 -10.6   8.19e-17
-#>  9 Melbourne Victoria Other    arima  constant    1.24   0.640    1.93  5.70e- 2
-#> 10 Melbourne Victoria Visiting arima  ma1        -0.838  0.0652 -12.8   5.03e-21
-#> 11 Melbourne Victoria Visiting arima  sar1        0.659  0.193    3.41  1.03e- 3
-#> 12 Melbourne Victoria Visiting arima  sma1       -0.402  0.206   -1.95  5.47e- 2
-#> 13 Melbourne Victoria Visiting arima  sma2        0.322  0.143    2.26  2.68e- 2
-#> # … with abbreviated variable names ¹​std.error, ²​statistic
-

The glance() function provides a one-row summary of each model, and commonly includes descriptions of the model’s fit such as the residual variance and information criteria. Be wary though, as information criteria (AIC, AICc, BIC) are only comparable between the same model class and only if those models share the same response (after transformations and differencing).

+#> Region State Purpose .model term estimate std.error statistic p.value +#> <chr> <chr> <chr> <chr> <chr> <dbl> <dbl> <dbl> <dbl> +#> 1 Melbourne Victoria Busine… arima ma1 -0.555 0.130 -4.28 5.29e- 5 +#> 2 Melbourne Victoria Busine… arima ma2 -0.233 0.129 -1.81 7.47e- 2 +#> 3 Melbourne Victoria Busine… arima sar1 0.946 0.0634 14.9 1.08e-24 +#> 4 Melbourne Victoria Busine… arima sma1 -0.772 0.145 -5.34 8.81e- 7 +#> 5 Melbourne Victoria Busine… arima cons… 0.192 0.213 0.903 3.69e- 1 +#> 6 Melbourne Victoria Holiday arima ma1 -0.931 0.0851 -10.9 1.77e-17 +#> 7 Melbourne Victoria Holiday arima cons… 3.65 0.571 6.39 1.06e- 8 +#> 8 Melbourne Victoria Other arima ma1 -0.750 0.0708 -10.6 8.19e-17 +#> 9 Melbourne Victoria Other arima cons… 1.24 0.640 1.93 5.70e- 2 +#> 10 Melbourne Victoria Visiti… arima ma1 -0.838 0.0652 -12.8 5.03e-21 +#> 11 Melbourne Victoria Visiti… arima sar1 0.659 0.193 3.41 1.03e- 3 +#> 12 Melbourne Victoria Visiti… arima sma1 -0.402 0.206 -1.95 5.47e- 2 +#> 13 Melbourne Victoria Visiti… arima sma2 0.322 0.143 2.26 2.68e- 2
+

The glance() function provides a one-row summary of each +model, and commonly includes descriptions of the model’s fit such as the +residual variance and information criteria. Be wary though, as +information criteria (AIC, AICc, BIC) are only comparable between the +same model class and only if those models share the same response (after +transformations and differencing).

 fit %>%
   glance()
@@ -183,8 +222,10 @@ 

Introduction to fable

#> 6 Melbourne Victor… Other arima 4.89e+2 -356. 718. 719. 725. NA NA #> 7 Melbourne Victor… Visiti… ets 1.09e-2 -503. 1024. 1026. 1045. 3714. 3860. #> 8 Melbourne Victor… Visiti… arima 4.24e+3 -442. 893. 894. 905. NA NA -#> # … with 3 more variables: MAE <dbl>, ar_roots <list>, ma_roots <list>
-

If you’re working with a single model (or want to look at one model in particular), the report() function gives a familiar and nicely formatted model-specific display.

+#> # ℹ 3 more variables: MAE <dbl>, ar_roots <list>, ma_roots <list>
+

If you’re working with a single model (or want to look at one model +in particular), the report() function gives a familiar and +nicely formatted model-specific display.

 fit %>%
   filter(Purpose == "Holiday") %>%
@@ -205,7 +246,11 @@ 

Introduction to fable

#> #> AIC AICc BIC #> 991.7305 994.3020 1013.1688
-

The fitted values and residuals from a model can obtained using fitted() and residuals() respectively. Additionally, the augment() function may be more convenient, which provides the original data along with both fitted values and their residuals.

+

The fitted values and residuals from a model can obtained using +fitted() and residuals() respectively. +Additionally, the augment() function may be more +convenient, which provides the original data along with both fitted +values and their residuals.

 fit %>%
   augment()
@@ -223,11 +268,17 @@ 

Introduction to fable

#> 8 Melbourne Victoria Business ets 1999 Q4 426. 424. 1.49 1.49 #> 9 Melbourne Victoria Business ets 2000 Q1 495. 364. 130. 130. #> 10 Melbourne Victoria Business ets 2000 Q2 499. 477. 22.0 22.0 -#> # … with 630 more rows
-

To compare how well the models fit the data, we can consider some common accuracy measures. It seems that on the training set the ETS model out-performs ARIMA for the series where travellers are on holiday, business, and visiting friends and relatives. The Evaluating modelling accuracy chapter from the Forecasting: Principles and Practices (3rd Ed.) textbook provides more detail in how modelling and forecasting accuracy is evaluated.

+#> # ℹ 630 more rows
+

To compare how well the models fit the data, we can consider some +common accuracy measures. It seems that on the training set the ETS +model out-performs ARIMA for the series where travellers are on holiday, +business, and visiting friends and relatives. The Evaluating modelling +accuracy chapter from the Forecasting: Principles and +Practices (3rd Ed.) textbook provides more detail in how +modelling and forecasting accuracy is evaluated.

 fit %>%
-  accuracy() %>%
+  accuracy() %>%
   arrange(MASE)
 #> # A tibble: 8 × 13
 #>   Region  State Purpose .model .type     ME  RMSE   MAE    MPE  MAPE  MASE RMSSE
@@ -240,11 +291,12 @@ 

Introduction to fable

#> 6 Melbou… Vict… Other ets Trai… -0.142 21.7 17.0 -5.97 19.6 0.767 0.773 #> 7 Melbou… Vict… Visiti… ets Trai… 8.17 60.9 51.4 0.433 8.28 0.819 0.782 #> 8 Melbou… Vict… Visiti… arima Trai… 6.89 63.1 51.7 0.106 8.44 0.825 0.809 -#> # … with 1 more variable: ACF1 <dbl>
-

Forecasts from these models can be produced directly as our specified models do not require any additional data.

+#> # ℹ 1 more variable: ACF1 <dbl> +

Forecasts from these models can be produced directly as our specified +models do not require any additional data.

 fc <- fit %>%
-  forecast(h = "5 years")
+  forecast(h = "5 years")
 fc
 #> # A fable: 160 x 7 [1Q]
 #> # Key:     Region, State, Purpose, .model [8]
@@ -260,13 +312,17 @@ 

Introduction to fable

#> 8 Melbourne Victoria Business ets 2019 Q4 N(759, 6181) 759. #> 9 Melbourne Victoria Business ets 2020 Q1 N(710, 6786) 710. #> 10 Melbourne Victoria Business ets 2020 Q2 N(800, 7458) 800. -#> # … with 150 more rows
-

The resulting forecasts are contained in a “fable” (forecast table), and both point forecasts and forecast distributions are available in the table for the next five years. Confidence intervals can be extracted from the distribution using the hilo() function.

+#> # ℹ 150 more rows +

The resulting forecasts are contained in a “fable” (forecast table), +and both point forecasts and forecast distributions are available in the +table for the next five years. Confidence intervals can be extracted +from the distribution using the hilo() function.

-

The hilo() function can also be used on fable objects, which allows you to extract multiple intervals at once.

+

The hilo() function can also be used on fable objects, +which allows you to extract multiple intervals at once.

 fc %>%
   hilo(level = c(80, 95))
@@ -284,7 +340,8 @@ 

Introduction to fable

#> 8 Melbo… Vict… Busine… ets 2019 Q4 N(759, 6181) 759. [658.1603, 859.6735]80 #> 9 Melbo… Vict… Busine… ets 2020 Q1 N(710, 6786) 710. [603.9336, 815.0789]80 #> 10 Melbo… Vict… Busine… ets 2020 Q2 N(800, 7458) 800. [689.3620, 910.7146]80 -#> # … with 150 more rows, and 1 more variable: `95%` <hilo>
+#> # ℹ 150 more rows +#> # ℹ 1 more variable: `95%` <hilo> -

You can also see a plot of the forecasts using autoplot(). To see the historical data along with the forecasts you can provide it as the first argument to the function.

+

You can also see a plot of the forecasts using +autoplot(). To see the historical data along with the +forecasts you can provide it as the first argument to the function.

 fc %>%
   autoplot(tourism_melb)

-

More model methods may be supported by particular models, including the ability to refit() the model to new data, stream() in new data to extend the fit, generate() simulated paths from a model, interpolate() missing values, extract components() from the fitted model, and display the model’s equation().

-

More information about modelling time series and using the fable package can be found in Forecasting: Principles and Practices (3rd Ed.) and in the pkgdown site.

+

More model methods may be supported by particular models, including +the ability to refit() the model to new data, +stream() in new data to extend the fit, +generate() simulated paths from a model, +interpolate() missing values, extract +components() from the fitted model, and display the model’s +equation().

+

More information about modelling time series and using the fable +package can be found in Forecasting: Principles and +Practices (3rd Ed.) and in the pkgdown site.

@@ -80,7 +80,7 @@

All vignettes

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/articles/transformations.html b/dev/articles/transformations.html index 0372e656..84b04c68 100644 --- a/dev/articles/transformations.html +++ b/dev/articles/transformations.html @@ -41,7 +41,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -89,11 +89,12 @@ -
+
-

O'Hara-Wild M, Hyndman R, Wang E (2022). +

O'Hara-Wild M, Hyndman R, Wang E (2024). fable: Forecasting Models for Tidy Time Series. -https://fable.tidyverts.org, https://github.com/tidyverts/fable. +R package version 0.3.3.9000, https://github.com/tidyverts/fable, https://fable.tidyverts.org.

@Manual{,
   title = {fable: Forecasting Models for Tidy Time Series},
   author = {Mitchell O'Hara-Wild and Rob Hyndman and Earo Wang},
-  year = {2022},
-  note = {https://fable.tidyverts.org, https://github.com/tidyverts/fable},
+  year = {2024},
+  note = {R package version 0.3.3.9000, https://github.com/tidyverts/fable},
+  url = {https://fable.tidyverts.org},
 }
@@ -123,7 +124,7 @@

Citation

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/index.html b/dev/index.html index a09b1c57..a00de553 100644 --- a/dev/index.html +++ b/dev/index.html @@ -46,7 +46,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -101,6 +101,7 @@ +

The R package fable provides a collection of commonly used univariate and multivariate time series forecasting models including exponential smoothing via state space models and automatic ARIMA modelling. These models work within the fable framework, which provides the tools to evaluate, visualise, and combine models in a workflow consistent with the tidyverse.

Installation @@ -133,7 +134,7 @@

Example arima = ARIMA(log(Turnover)), snaive = SNAIVE(Turnover) ) %>% - forecast(h = "2 years") %>% + forecast(h = "2 years") %>% autoplot(filter(aus_retail, year(Month) > 2010), level = NULL)

@@ -218,7 +219,7 @@

Dev status

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/news/index.html b/dev/news/index.html index 33464ba4..379351d2 100644 --- a/dev/news/index.html +++ b/dev/news/index.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -63,7 +63,26 @@

Changelog

Source: NEWS.md -
+
+ +
+

Improvements

+
  • Documentation improvements.
  • +
+
+
+ +

Small patch to resolve CRAN check issues.

+
+

Improvements

+
  • Documentation improvements.
  • +
+
+

Bug fixes

+
  • Fixed generate(<ARIMA>) method for some variable names.
  • +
  • Fixed df in generate(<TSLM>).
  • +
+
@@ -107,7 +126,7 @@

Improvements

@@ -125,10 +144,11 @@

Bug fixes -

This release coincides with v0.2.0 of the fabletools package, which contains some substantial changes to the output of forecast() methods. These changes to fabletools emphasise the distribution in the fable object. The most noticeable is a change in column names of the fable, with the distribution now stored in the column matching the response variable, and the forecast mean now stored in the .mean column. For a complete summary of these changes, refer to the fabletools v0.2.0 release news: https://fabletools.tidyverts.org/news/index.html

+

This release coincides with v0.2.0 of the fabletools package, which contains some substantial changes to the output of forecast() methods. These changes to fabletools emphasise the distribution in the fable object. The most noticeable is a change in column names of the fable, with the distribution now stored in the column matching the response variable, and the forecast mean now stored in the .mean column. For a complete summary of these changes, refer to the fabletools v0.2.0 release news: https://fabletools.tidyverts.org/news/index.html

New features

-
+

Improvements

  • Forecasts distributions are now provided by the distributional package. They are now more space efficient and allows calculation of distributional statistics including the mean(), median(), variance(), quantile(), cdf(), and density().
  • @@ -144,7 +164,8 @@

    Bug fixes

    Breaking changes

    -
    • The sample path means are now used instead of analytical means when forecasts are produced from sample paths.

+
  • The sample path means are now used instead of analytical means when forecasts are produced from sample paths.
  • +
@@ -183,13 +204,16 @@

Improvements

Bug fixes

-
  • Corrected forecast standard error for drift models.
+
  • Corrected forecast standard error for drift models.
  • +
-
  • First release.
+
  • First release.
  • +

New features

-
  • Support for 9 models and relevant methods: ARIMA, ETS, TSLM, MEAN, RW, NAIVE, SNAIVE, NNETAR, VAR.
+
  • Support for 9 models and relevant methods: ARIMA, ETS, TSLM, MEAN, RW, NAIVE, SNAIVE, NNETAR, VAR.
  • +
@@ -205,7 +229,7 @@

New features
-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/pkgdown.yml b/dev/pkgdown.yml index ceda350a..e8b31703 100644 --- a/dev/pkgdown.yml +++ b/dev/pkgdown.yml @@ -1,10 +1,10 @@ -pandoc: 2.7.3 -pkgdown: 2.0.6 +pandoc: 2.19.2 +pkgdown: 2.0.7 pkgdown_sha: ~ articles: fable: fable.html transformations: transformations.html -last_built: 2022-10-25T11:07Z +last_built: 2024-02-01T04:02Z urls: reference: https://fable.tidyverts.org/reference article: https://fable.tidyverts.org/articles diff --git a/dev/reference/AR-1.png b/dev/reference/AR-1.png index 7cd6f91f..93b7d439 100644 Binary files a/dev/reference/AR-1.png and b/dev/reference/AR-1.png differ diff --git a/dev/reference/AR.html b/dev/reference/AR.html index 85364d90..3b3398eb 100644 --- a/dev/reference/AR.html +++ b/dev/reference/AR.html @@ -19,7 +19,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -146,7 +146,7 @@

Examples

#> AIC = -14.48 AICc = -13.55 BIC = -7 fit %>% - forecast() %>% + forecast() %>% autoplot(luteinizing_hormones)
@@ -163,7 +163,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/ARIMA.html b/dev/reference/ARIMA.html index 1d82d216..6cbbb8c5 100644 --- a/dev/reference/ARIMA.html +++ b/dev/reference/ARIMA.html @@ -20,7 +20,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -255,7 +255,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/CROSTON-1.png b/dev/reference/CROSTON-1.png index 908fb518..490b48c6 100644 Binary files a/dev/reference/CROSTON-1.png and b/dev/reference/CROSTON-1.png differ diff --git a/dev/reference/CROSTON-2.png b/dev/reference/CROSTON-2.png index 5fb913f4..c5034174 100644 Binary files a/dev/reference/CROSTON-2.png and b/dev/reference/CROSTON-2.png differ diff --git a/dev/reference/CROSTON.html b/dev/reference/CROSTON.html index 29e71f1a..8f7a59f9 100644 --- a/dev/reference/CROSTON.html +++ b/dev/reference/CROSTON.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -165,7 +165,7 @@

Examples

sim_poisson %>% model(CROSTON(count)) %>% - forecast(h = "2 years") %>% + forecast(h = "2 years") %>% autoplot(sim_poisson)
@@ -182,7 +182,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/ETS.html b/dev/reference/ETS.html index ffe35d5a..16eb676a 100644 --- a/dev/reference/ETS.html +++ b/dev/reference/ETS.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -205,7 +205,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/MEAN.html b/dev/reference/MEAN.html index e3ca348b..1fb2181d 100644 --- a/dev/reference/MEAN.html +++ b/dev/reference/MEAN.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -129,7 +129,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/NNETAR.html b/dev/reference/NNETAR.html index e2a42280..3ea14367 100644 --- a/dev/reference/NNETAR.html +++ b/dev/reference/NNETAR.html @@ -18,7 +18,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -173,7 +173,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/RW.html b/dev/reference/RW.html index 3127e1a5..e233f427 100644 --- a/dev/reference/RW.html +++ b/dev/reference/RW.html @@ -21,7 +21,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -120,7 +120,7 @@

lag

The lag special is used to specify the lag order for the random walk process. If left out, this special will automatically be included.


-lag(lag = NULL)
+lag(lag = NULL)
lagThe lag order for the random walk process. If lag = m, forecasts will return the observation from m time periods ago. This can also be provided as text indicating the duration of the lag window (for example, annual seasonal lags would be "1 year").
@@ -156,7 +156,7 @@

Examples

#> 1 <NAIVE> library(tsibbledata) aus_production %>% - model(snaive = SNAIVE(Beer ~ lag("year"))) + model(snaive = SNAIVE(Beer ~ lag("year"))) #> # A mable: 1 x 1 #> snaive #> <model> @@ -175,7 +175,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/Rplot002.png b/dev/reference/Rplot002.png index d10c8384..20367173 100644 Binary files a/dev/reference/Rplot002.png and b/dev/reference/Rplot002.png differ diff --git a/dev/reference/THETA.html b/dev/reference/THETA.html index 2751fb0a..b97ad5ee 100644 --- a/dev/reference/THETA.html +++ b/dev/reference/THETA.html @@ -19,7 +19,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -132,7 +132,7 @@

Examples

deaths <- as_tsibble(USAccDeaths) deaths %>% model(theta = THETA(log(value))) %>% - forecast(h = "4 years") %>% + forecast(h = "4 years") %>% autoplot(deaths) @@ -143,27 +143,27 @@

Examples

filter(Industry == "Clothing retailing") %>% model(theta_multiplicative = THETA(Turnover ~ season(method = "multiplicative")), theta_additive = THETA(Turnover ~ season(method = "additive"))) %>% - accuracy() + accuracy() #> # A tibble: 16 × 12 -#> State Indus…¹ .model .type ME RMSE MAE MPE MAPE MASE RMSSE -#> <chr> <chr> <chr> <chr> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> -#> 1 Australi… Clothi… theta… Trai… 0.0732 0.889 0.646 0.288 5.80 0.511 0.508 -#> 2 Australi… Clothi… theta… Trai… 0.168 1.52 1.03 1.76 10.4 0.812 0.871 -#> 3 New Sout… Clothi… theta… Trai… 2.49 14.1 10.3 0.688 4.16 0.551 0.576 -#> 4 New Sout… Clothi… theta… Trai… 4.74 28.0 17.5 2.13 7.38 0.932 1.15 -#> 5 Northern… Clothi… theta… Trai… 0.0266 0.422 0.320 0.225 5.67 0.417 0.418 -#> 6 Northern… Clothi… theta… Trai… 0.0324 0.506 0.393 0.415 7.60 0.512 0.501 -#> 7 Queensla… Clothi… theta… Trai… 1.12 9.01 6.13 0.612 4.75 0.497 0.539 -#> 8 Queensla… Clothi… theta… Trai… 1.70 16.3 10.8 2.09 10.9 0.874 0.978 -#> 9 South Au… Clothi… theta… Trai… 0.167 2.95 2.01 0.0804 5.27 0.400 0.406 -#> 10 South Au… Clothi… theta… Trai… 0.245 4.51 2.96 0.590 7.89 0.591 0.621 -#> 11 Tasmania Clothi… theta… Trai… 0.0485 1.28 0.861 -0.0436 6.18 0.505 0.470 -#> 12 Tasmania Clothi… theta… Trai… 0.0780 1.77 1.06 0.561 7.36 0.620 0.649 -#> 13 Victoria Clothi… theta… Trai… 1.48 10.5 7.75 0.465 4.22 0.476 0.473 -#> 14 Victoria Clothi… theta… Trai… 2.89 20.9 13.8 1.54 7.37 0.845 0.939 -#> 15 Western … Clothi… theta… Trai… 0.323 3.82 2.78 0.362 4.49 0.455 0.481 -#> 16 Western … Clothi… theta… Trai… 0.559 6.44 4.56 1.28 8.13 0.746 0.812 -#> # … with 1 more variable: ACF1 <dbl>, and abbreviated variable name ¹​Industry +#> State Industry .model .type ME RMSE MAE MPE MAPE MASE RMSSE +#> <chr> <chr> <chr> <chr> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> +#> 1 Austral… Clothin… theta… Trai… 0.0732 0.889 0.646 0.288 5.80 0.511 0.508 +#> 2 Austral… Clothin… theta… Trai… 0.168 1.52 1.03 1.76 10.4 0.812 0.871 +#> 3 New Sou… Clothin… theta… Trai… 2.49 14.1 10.3 0.688 4.16 0.551 0.576 +#> 4 New Sou… Clothin… theta… Trai… 4.74 28.0 17.5 2.13 7.38 0.932 1.15 +#> 5 Norther… Clothin… theta… Trai… 0.0266 0.422 0.320 0.225 5.67 0.417 0.418 +#> 6 Norther… Clothin… theta… Trai… 0.0324 0.506 0.393 0.415 7.60 0.512 0.501 +#> 7 Queensl… Clothin… theta… Trai… 1.12 9.01 6.13 0.612 4.75 0.497 0.539 +#> 8 Queensl… Clothin… theta… Trai… 1.70 16.3 10.8 2.09 10.9 0.874 0.978 +#> 9 South A… Clothin… theta… Trai… 0.167 2.95 2.01 0.0804 5.27 0.400 0.406 +#> 10 South A… Clothin… theta… Trai… 0.245 4.51 2.96 0.590 7.89 0.591 0.621 +#> 11 Tasmania Clothin… theta… Trai… 0.0485 1.28 0.861 -0.0436 6.18 0.505 0.470 +#> 12 Tasmania Clothin… theta… Trai… 0.0780 1.77 1.06 0.561 7.36 0.620 0.649 +#> 13 Victoria Clothin… theta… Trai… 1.48 10.5 7.75 0.465 4.22 0.476 0.473 +#> 14 Victoria Clothin… theta… Trai… 2.89 20.9 13.8 1.54 7.37 0.845 0.939 +#> 15 Western… Clothin… theta… Trai… 0.323 3.82 2.78 0.362 4.49 0.455 0.481 +#> 16 Western… Clothin… theta… Trai… 0.559 6.44 4.56 1.28 8.13 0.746 0.812 +#> # ℹ 1 more variable: ACF1 <dbl> @@ -178,7 +178,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/TSLM.html b/dev/reference/TSLM.html index c30c8768..c9e2534c 100644 --- a/dev/reference/TSLM.html +++ b/dev/reference/TSLM.html @@ -21,7 +21,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -138,7 +138,7 @@

Examples

#> 8 100 men 1924 10.6 #> 9 100 men 1928 10.8 #> 10 100 men 1932 10.3 -#> # … with 302 more rows +#> # ℹ 302 more rows @@ -153,7 +153,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/VAR.html b/dev/reference/VAR.html index d49a0921..4336dfb5 100644 --- a/dev/reference/VAR.html +++ b/dev/reference/VAR.html @@ -18,7 +18,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -164,7 +164,7 @@

Examples

#> AIC = 1660.69 AICc = 1674.37 BIC = 1700.9 fit %>% - forecast() %>% + forecast() %>% autoplot(lung_deaths) @@ -181,7 +181,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/breusch_godfrey.html b/dev/reference/breusch_godfrey.html index 5aa41aca..c8ed3c9a 100644 --- a/dev/reference/breusch_godfrey.html +++ b/dev/reference/breusch_godfrey.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -110,7 +110,7 @@

See also

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/common_xregs.html b/dev/reference/common_xregs.html index ec879152..aa68af30 100644 --- a/dev/reference/common_xregs.html +++ b/dev/reference/common_xregs.html @@ -18,7 +18,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -114,7 +114,7 @@

fourier
-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/components.ETS.html b/dev/reference/components.ETS.html index d08fe910..2ffa1b0b 100644 --- a/dev/reference/components.ETS.html +++ b/dev/reference/components.ETS.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -111,7 +111,7 @@

Examples

#> 8 ets 1972 Aug NA NA NA 0.110 NA #> 9 ets 1972 Sep NA NA NA -0.00355 NA #> 10 ets 1972 Oct NA NA NA 0.0302 NA -#> # … with 74 more rows +#> # ℹ 74 more rows @@ -126,7 +126,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/fable-package.html b/dev/reference/fable-package.html index e43b40ff..e1c73ecb 100644 --- a/dev/reference/fable-package.html +++ b/dev/reference/fable-package.html @@ -18,7 +18,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -101,7 +101,7 @@

Author

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/fitted.AR.html b/dev/reference/fitted.AR.html index 04f3324f..1bcd4558 100644 --- a/dev/reference/fitted.AR.html +++ b/dev/reference/fitted.AR.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,11 +76,11 @@

Extract fitted values from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -109,7 +109,7 @@

Examples

#> 8 AR(value ~ order(3)) 8 2.46 #> 9 AR(value ~ order(3)) 9 2.55 #> 10 AR(value ~ order(3)) 10 2.49 -#> # … with 38 more rows +#> # ℹ 38 more rows
@@ -124,7 +124,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/fitted.ARIMA.html b/dev/reference/fitted.ARIMA.html index ee59f9ad..0bfe629d 100644 --- a/dev/reference/fitted.ARIMA.html +++ b/dev/reference/fitted.ARIMA.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,11 +76,11 @@

Extract fitted values from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -110,7 +110,7 @@

Examples

#> 8 arima 1973 Aug 10737. #> 9 arima 1973 Sep 9708. #> 10 arima 1973 Oct 9933. -#> # … with 62 more rows +#> # ℹ 62 more rows
@@ -125,7 +125,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/fitted.ETS.html b/dev/reference/fitted.ETS.html index 899d603f..357eccdb 100644 --- a/dev/reference/fitted.ETS.html +++ b/dev/reference/fitted.ETS.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,11 +76,11 @@

Extract fitted values from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -109,7 +109,7 @@

Examples

#> 8 ets 1973 Aug 10652. #> 9 ets 1973 Sep 9525. #> 10 ets 1973 Oct 9927. -#> # … with 62 more rows +#> # ℹ 62 more rows
@@ -124,7 +124,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/fitted.NNETAR.html b/dev/reference/fitted.NNETAR.html index 8055dc57..b472ebaa 100644 --- a/dev/reference/fitted.NNETAR.html +++ b/dev/reference/fitted.NNETAR.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,11 +76,11 @@

Extract fitted values from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -103,13 +103,13 @@

Examples

#> 2 nn 1938 571. #> 3 nn 1939 655. #> 4 nn 1940 906. -#> 5 nn 1941 1361. -#> 6 nn 1942 1771. -#> 7 nn 1943 1811. -#> 8 nn 1944 2077. -#> 9 nn 1945 2744. -#> 10 nn 1946 4190. -#> # … with 14 more rows +#> 5 nn 1941 1359. +#> 6 nn 1942 1768. +#> 7 nn 1943 1808. +#> 8 nn 1944 2073. +#> 9 nn 1945 2740. +#> 10 nn 1946 4183. +#> # ℹ 14 more rows
@@ -124,7 +124,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/fitted.RW.html b/dev/reference/fitted.RW.html index 3737096c..aa947f3b 100644 --- a/dev/reference/fitted.RW.html +++ b/dev/reference/fitted.RW.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,11 +76,11 @@

Extract fitted values from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -109,11 +109,11 @@

Examples

#> 8 NAIVE(value) 1878 813 #> 9 NAIVE(value) 1879 1230 #> 10 NAIVE(value) 1880 1370 -#> # … with 90 more rows +#> # ℹ 90 more rows library(tsibbledata) aus_production %>% - model(snaive = SNAIVE(Beer ~ lag("year"))) %>% + model(snaive = SNAIVE(Beer ~ lag("year"))) %>% fitted() #> # A tsibble: 218 x 3 [1Q] #> # Key: .model [1] @@ -129,7 +129,7 @@

Examples

#> 8 snaive 1957 Q4 308 #> 9 snaive 1958 Q1 262 #> 10 snaive 1958 Q2 228 -#> # … with 208 more rows +#> # ℹ 208 more rows
@@ -144,7 +144,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/fitted.TSLM.html b/dev/reference/fitted.TSLM.html index 7e857094..b198ff5e 100644 --- a/dev/reference/fitted.TSLM.html +++ b/dev/reference/fitted.TSLM.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,11 +76,11 @@

Extract fitted values from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -109,7 +109,7 @@

Examples

#> 8 lm 1973 Aug 10121. #> 9 lm 1973 Sep 9025. #> 10 lm 1973 Oct 9331. -#> # … with 62 more rows +#> # ℹ 62 more rows
@@ -124,7 +124,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/fitted.VAR.html b/dev/reference/fitted.VAR.html index 73000da6..2c5fd041 100644 --- a/dev/reference/fitted.VAR.html +++ b/dev/reference/fitted.VAR.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,11 +76,11 @@

Extract fitted values from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -112,7 +112,7 @@

Examples

#> 8 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1974 Aug 1422. 505. #> 9 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1974 Sep 1311. 471. #> 10 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1974 Oct 1342. 480. -#> # … with 62 more rows +#> # ℹ 62 more rows
@@ -127,7 +127,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/fitted.croston.html b/dev/reference/fitted.croston.html index 792ec039..622eb58a 100644 --- a/dev/reference/fitted.croston.html +++ b/dev/reference/fitted.croston.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,11 +76,11 @@

Extract fitted values from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -105,10 +105,10 @@

Examples

#> # A tibble: 4 × 3 #> .model term estimate #> <chr> <chr> <dbl> -#> 1 CROSTON(count) demand_init 0.703 -#> 2 CROSTON(count) demand_par 0 -#> 3 CROSTON(count) interval_init 7.03 -#> 4 CROSTON(count) interval_par 0 +#> 1 CROSTON(count) demand_init 1.05 +#> 2 CROSTON(count) demand_par 0 +#> 3 CROSTON(count) interval_init 2.42 +#> 4 CROSTON(count) interval_par 0
@@ -123,7 +123,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/fitted.fable_theta.html b/dev/reference/fitted.fable_theta.html index de0642c4..1a90029f 100644 --- a/dev/reference/fitted.fable_theta.html +++ b/dev/reference/fitted.fable_theta.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,11 +76,11 @@

Extract fitted values from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -110,7 +110,7 @@

Examples

#> 8 avg 2012-01-01 03:30:00 4665. #> 9 avg 2012-01-01 04:00:00 4665. #> 10 avg 2012-01-01 04:30:00 4665. -#> # … with 52,598 more rows +#> # ℹ 52,598 more rows
@@ -125,7 +125,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/fitted.model_mean.html b/dev/reference/fitted.model_mean.html index 1a6284f7..e6a456f8 100644 --- a/dev/reference/fitted.model_mean.html +++ b/dev/reference/fitted.model_mean.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,11 +76,11 @@

Extract fitted values from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -110,7 +110,7 @@

Examples

#> 8 avg 2012-01-01 03:30:00 4665. #> 9 avg 2012-01-01 04:00:00 4665. #> 10 avg 2012-01-01 04:30:00 4665. -#> # … with 52,598 more rows +#> # ℹ 52,598 more rows
@@ -125,7 +125,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/forecast.AR.html b/dev/reference/forecast.AR.html index 3bbac246..0b76ecac 100644 --- a/dev/reference/forecast.AR.html +++ b/dev/reference/forecast.AR.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -70,7 +70,7 @@

Forecast a model from the fable package

# S3 method for AR
-forecast(
+forecast(
   object,
   new_data = NULL,
   specials = NULL,
@@ -83,15 +83,15 @@ 

Forecast a model from the fable package

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

bootstrap
@@ -103,7 +103,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -117,7 +117,7 @@

Value

Examples

as_tsibble(lh) %>%
   model(AR(value ~ order(3))) %>%
-  forecast()
+  forecast()
 #> # A fable: 2 x 4 [1]
 #> # Key:     .model [1]
 #>   .model               index        value .mean
@@ -138,7 +138,7 @@ 

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/forecast.ARIMA.html b/dev/reference/forecast.ARIMA.html index 392020ce..fc5d9077 100644 --- a/dev/reference/forecast.ARIMA.html +++ b/dev/reference/forecast.ARIMA.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000
@@ -70,7 +70,7 @@

Forecast a model from the fable package

# S3 method for ARIMA
-forecast(
+forecast(
   object,
   new_data = NULL,
   specials = NULL,
@@ -83,15 +83,15 @@ 

Forecast a model from the fable package

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

bootstrap
@@ -103,7 +103,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -118,7 +118,7 @@

Examples

USAccDeaths %>%
   as_tsibble() %>%
   model(arima = ARIMA(log(value) ~ pdq(0, 1, 1) + PDQ(0, 1, 1))) %>%
-  forecast()
+  forecast()
 #> # A fable: 24 x 4 [1M]
 #> # Key:     .model [1]
 #>    .model    index             value  .mean
@@ -133,7 +133,7 @@ 

Examples

#> 8 arima 1979 Aug t(N(9.2, 0.0041)) 10132. #> 9 arima 1979 Sep t(N(9.1, 0.0045)) 9138. #> 10 arima 1979 Oct t(N(9.1, 0.0049)) 9391. -#> # … with 14 more rows +#> # ℹ 14 more rows
@@ -148,7 +148,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/forecast.ETS.html b/dev/reference/forecast.ETS.html index 39ec0c60..919df93f 100644 --- a/dev/reference/forecast.ETS.html +++ b/dev/reference/forecast.ETS.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -70,7 +70,7 @@

Forecast a model from the fable package

# S3 method for ETS
-forecast(
+forecast(
   object,
   new_data,
   specials = NULL,
@@ -84,15 +84,15 @@ 

Forecast a model from the fable package

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

simulate
@@ -108,7 +108,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -122,7 +122,7 @@

Value

Examples

as_tsibble(USAccDeaths) %>%
   model(ets = ETS(log(value) ~ season("A"))) %>%
-  forecast()
+  forecast()
 #> # A fable: 24 x 4 [1M]
 #> # Key:     .model [1]
 #>    .model    index             value  .mean
@@ -137,7 +137,7 @@ 

Examples

#> 8 ets 1979 Aug t(N(9.2, 0.004)) 10252. #> 9 ets 1979 Sep t(N(9.1, 0.0045)) 9169. #> 10 ets 1979 Oct t(N(9.2, 0.005)) 9499. -#> # … with 14 more rows +#> # ℹ 14 more rows
@@ -152,7 +152,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/forecast.NNETAR.html b/dev/reference/forecast.NNETAR.html index ae402c74..c336d944 100644 --- a/dev/reference/forecast.NNETAR.html +++ b/dev/reference/forecast.NNETAR.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -70,13 +70,13 @@

Forecast a model from the fable package

# S3 method for NNETAR
-forecast(
+forecast(
   object,
   new_data,
   specials = NULL,
   simulate = TRUE,
   bootstrap = FALSE,
-  times = 1000,
+  times = 5000,
   ...
 )
@@ -84,31 +84,31 @@

Forecast a model from the fable package

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

simulate
-

If TRUE, prediction intervals are produced by simulation rather than using analytic formulae.

+

If TRUE, forecast distributions are produced by sampling from a normal distribution. Without simulation, forecast uncertainty cannot be estimated for this model and instead a degenerate distribution with the forecast mean will be produced.

bootstrap
-

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

+

If TRUE, forecast distributions are produced by sampling from the model's training residuals.

times
-

The number of sample paths to use in estimating the forecast distribution if simulated intervals are used.

+

The number of sample paths to use in producing the forecast distribution. Setting simulate = FALSE or times = 0 will produce degenerate forecast distributions of the forecast mean.

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -122,13 +122,13 @@

Value

Examples

as_tsibble(airmiles) %>%
   model(nn = NNETAR(box_cox(value, 0.15))) %>%
-  forecast(times = 10)
+  forecast(times = 10)
 #> # A fable: 2 x 4 [1Y]
 #> # Key:     .model [1]
-#>   .model index         value  .mean
-#>   <chr>  <dbl>        <dist>  <dbl>
-#> 1 nn      1961 t(sample[10]) 31555.
-#> 2 nn      1962 t(sample[10]) 32102.
+#>   .model index      value  .mean
+#>   <chr>  <dbl>     <dist>  <dbl>
+#> 1 nn      1961 sample[10] 31085.
+#> 2 nn      1962 sample[10] 33936.
 
@@ -143,7 +143,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/forecast.RW.html b/dev/reference/forecast.RW.html index 9ccac2a0..b542cb1d 100644 --- a/dev/reference/forecast.RW.html +++ b/dev/reference/forecast.RW.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -70,7 +70,7 @@

Forecast a model from the fable package

# S3 method for RW
-forecast(
+forecast(
   object,
   new_data,
   specials = NULL,
@@ -84,15 +84,15 @@ 

Forecast a model from the fable package

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

simulate
@@ -108,7 +108,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -122,7 +122,7 @@

Value

Examples

as_tsibble(Nile) %>%
   model(NAIVE(value)) %>%
-  forecast()
+  forecast()
 #> # A fable: 2 x 4 [1Y]
 #> # Key:     .model [1]
 #>   .model       index         value .mean
@@ -132,8 +132,8 @@ 

Examples

library(tsibbledata) aus_production %>% - model(snaive = SNAIVE(Beer ~ lag("year"))) %>% - forecast() + model(snaive = SNAIVE(Beer ~ lag("year"))) %>% + forecast() #> # A fable: 8 x 4 [1Q] #> # Key: .model [1] #> .model Quarter Beer .mean @@ -160,7 +160,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/forecast.TSLM.html b/dev/reference/forecast.TSLM.html index c058c520..ba2ed76a 100644 --- a/dev/reference/forecast.TSLM.html +++ b/dev/reference/forecast.TSLM.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000
@@ -70,7 +70,7 @@

Forecast a model from the fable package

# S3 method for TSLM
-forecast(
+forecast(
   object,
   new_data,
   specials = NULL,
@@ -84,15 +84,15 @@ 

Forecast a model from the fable package

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

bootstrap
@@ -112,7 +112,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -126,7 +126,7 @@

Value

Examples

as_tsibble(USAccDeaths) %>%
   model(lm = TSLM(log(value) ~ trend() + season())) %>%
-  forecast()
+  forecast()
 #> # A fable: 24 x 4 [1M]
 #> # Key:     .model [1]
 #>    .model    index            value .mean
@@ -141,7 +141,7 @@ 

Examples

#> 8 lm 1979 Aug t(N(9.1, 0.003)) 9237. #> 9 lm 1979 Sep t(N(9, 0.003)) 8237. #> 10 lm 1979 Oct t(N(9, 0.003)) 8516. -#> # … with 14 more rows +#> # ℹ 14 more rows
@@ -156,7 +156,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/forecast.VAR.html b/dev/reference/forecast.VAR.html index c29dba42..16c30ff1 100644 --- a/dev/reference/forecast.VAR.html +++ b/dev/reference/forecast.VAR.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -70,7 +70,7 @@

Forecast a model from the fable package

# S3 method for VAR
-forecast(
+forecast(
   object,
   new_data = NULL,
   specials = NULL,
@@ -83,15 +83,15 @@ 

Forecast a model from the fable package

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

bootstrap
@@ -103,7 +103,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -120,23 +120,23 @@

Examples

lung_deaths %>% model(VAR(vars(mdeaths, fdeaths) ~ AR(3))) %>% - forecast() + forecast() #> # A fable: 24 x 4 [1M] #> # Key: .model [1] -#> .model index .distribution .mean[,"…¹ [,"fd…² -#> <chr> <mth> <dist> <dbl> <dbl> -#> 1 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1980 Jan MVN[2] 1486. 575. -#> 2 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1980 Feb MVN[2] 1445. 558. -#> 3 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1980 Mar MVN[2] 1369. 528. -#> 4 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1980 Apr MVN[2] 1340. 505. -#> 5 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1980 May MVN[2] 1327. 497. -#> 6 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1980 Jun MVN[2] 1349. 505. -#> 7 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1980 Jul MVN[2] 1395. 522. -#> 8 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1980 Aug MVN[2] 1442. 540. -#> 9 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1980 Sep MVN[2] 1477. 554. -#> 10 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1980 Oct MVN[2] 1495. 561. -#> # … with 14 more rows, and abbreviated variable names ¹​.mean[,"mdeaths"], -#> # ²​[,"fdeaths"] +#> .model index .distribution .mean[,"mdeaths"] +#> <chr> <mth> <dist> <dbl> +#> 1 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1980 Jan MVN[2] 1486. +#> 2 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1980 Feb MVN[2] 1445. +#> 3 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1980 Mar MVN[2] 1369. +#> 4 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1980 Apr MVN[2] 1340. +#> 5 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1980 May MVN[2] 1327. +#> 6 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1980 Jun MVN[2] 1349. +#> 7 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1980 Jul MVN[2] 1395. +#> 8 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1980 Aug MVN[2] 1442. +#> 9 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1980 Sep MVN[2] 1477. +#> 10 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1980 Oct MVN[2] 1495. +#> # ℹ 14 more rows +#> # ℹ 1 more variable: .mean[2] <dbl>
@@ -151,7 +151,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/forecast.croston.html b/dev/reference/forecast.croston.html index cbc7ec38..a0efdf36 100644 --- a/dev/reference/forecast.croston.html +++ b/dev/reference/forecast.croston.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -70,25 +70,25 @@

Forecast a model from the fable package

# S3 method for croston
-forecast(object, new_data, specials = NULL, ...)
+forecast(object, new_data, specials = NULL, ...)

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -109,22 +109,22 @@

Examples

sim_poisson %>% model(CROSTON(count)) %>% - forecast() + forecast() #> # A fable: 24 x 4 [1M] #> # Key: .model [1] -#> .model time count .mean -#> <chr> <mth> <dist> <dbl> -#> 1 CROSTON(count) 2015 Jan 0.4690177 0.469 -#> 2 CROSTON(count) 2015 Feb 0.4690177 0.469 -#> 3 CROSTON(count) 2015 Mar 0.4690177 0.469 -#> 4 CROSTON(count) 2015 Apr 0.4690177 0.469 -#> 5 CROSTON(count) 2015 May 0.4690177 0.469 -#> 6 CROSTON(count) 2015 Jun 0.4690177 0.469 -#> 7 CROSTON(count) 2015 Jul 0.4690177 0.469 -#> 8 CROSTON(count) 2015 Aug 0.4690177 0.469 -#> 9 CROSTON(count) 2015 Sep 0.4690177 0.469 -#> 10 CROSTON(count) 2015 Oct 0.4690177 0.469 -#> # … with 14 more rows +#> .model time count .mean +#> <chr> <mth> <dist> <dbl> +#> 1 CROSTON(count) 2015 Jan 0.5 0.5 +#> 2 CROSTON(count) 2015 Feb 0.5 0.5 +#> 3 CROSTON(count) 2015 Mar 0.5 0.5 +#> 4 CROSTON(count) 2015 Apr 0.5 0.5 +#> 5 CROSTON(count) 2015 May 0.5 0.5 +#> 6 CROSTON(count) 2015 Jun 0.5 0.5 +#> 7 CROSTON(count) 2015 Jul 0.5 0.5 +#> 8 CROSTON(count) 2015 Aug 0.5 0.5 +#> 9 CROSTON(count) 2015 Sep 0.5 0.5 +#> 10 CROSTON(count) 2015 Oct 0.5 0.5 +#> # ℹ 14 more rows
@@ -139,7 +139,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/forecast.fable_theta.html b/dev/reference/forecast.fable_theta.html index 93a8200c..5baaf340 100644 --- a/dev/reference/forecast.fable_theta.html +++ b/dev/reference/forecast.fable_theta.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -70,7 +70,7 @@

Forecast a model from the fable package

# S3 method for fable_theta
-forecast(
+forecast(
   object,
   new_data,
   specials = NULL,
@@ -83,15 +83,15 @@ 

Forecast a model from the fable package

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

bootstrap
@@ -103,7 +103,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -118,7 +118,7 @@

Examples

USAccDeaths %>%
   as_tsibble() %>%
   model(arima = ARIMA(log(value) ~ pdq(0, 1, 1) + PDQ(0, 1, 1))) %>%
-  forecast()
+  forecast()
 #> # A fable: 24 x 4 [1M]
 #> # Key:     .model [1]
 #>    .model    index             value  .mean
@@ -133,7 +133,7 @@ 

Examples

#> 8 arima 1979 Aug t(N(9.2, 0.0041)) 10132. #> 9 arima 1979 Sep t(N(9.1, 0.0045)) 9138. #> 10 arima 1979 Oct t(N(9.1, 0.0049)) 9391. -#> # … with 14 more rows +#> # ℹ 14 more rows
@@ -148,7 +148,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/forecast.model_mean.html b/dev/reference/forecast.model_mean.html index c92aebd9..e8caf0cb 100644 --- a/dev/reference/forecast.model_mean.html +++ b/dev/reference/forecast.model_mean.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -70,7 +70,7 @@

Forecast a model from the fable package

# S3 method for model_mean
-forecast(
+forecast(
   object,
   new_data,
   specials = NULL,
@@ -83,15 +83,15 @@ 

Forecast a model from the fable package

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

bootstrap
@@ -103,7 +103,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -118,7 +118,7 @@

Examples

library(tsibbledata)
 vic_elec %>%
   model(avg = MEAN(Demand)) %>%
-  forecast()
+  forecast()
 #> # A fable: 4 x 4 [30m] <Australia/Melbourne>
 #> # Key:     .model [1]
 #>   .model Time                         Demand .mean
@@ -141,7 +141,7 @@ 

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/generate.AR.html b/dev/reference/generate.AR.html index fc6f365c..2b94b85e 100644 --- a/dev/reference/generate.AR.html +++ b/dev/reference/generate.AR.html @@ -20,7 +20,7 @@ fable - 0.3.2.9000 + 0.3.3.9000
@@ -86,11 +86,11 @@

Arguments

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

bootstrap
@@ -98,7 +98,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -113,10 +113,10 @@

Examples

generate() #> # A tsibble: 2 x 4 [1] #> # Key: .model, .rep [1] -#> .model index .rep .sim -#> <chr> <dbl> <chr> <dbl> -#> 1 AR(value ~ order(3)) 49 1 2.20 -#> 2 AR(value ~ order(3)) 50 1 0.592 +#> .model .rep index .sim +#> <chr> <chr> <dbl> <dbl> +#> 1 AR(value ~ order(3)) 1 49 2.55 +#> 2 AR(value ~ order(3)) 1 50 1.50
@@ -131,7 +131,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/generate.ARIMA.html b/dev/reference/generate.ARIMA.html index 37ac80ff..f27b1d77 100644 --- a/dev/reference/generate.ARIMA.html +++ b/dev/reference/generate.ARIMA.html @@ -20,7 +20,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -86,11 +86,11 @@

Arguments

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

bootstrap
@@ -98,7 +98,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -113,19 +113,19 @@

Examples

fable_fit %>% generate(times = 10) #> # A tsibble: 240 x 4 [1M] #> # Key: .model, .rep [10] -#> .model index .rep .sim -#> <chr> <mth> <chr> <dbl> -#> 1 model 1979 Jan 1 8665. -#> 2 model 1979 Feb 1 7826. -#> 3 model 1979 Mar 1 7948. -#> 4 model 1979 Apr 1 8444. -#> 5 model 1979 May 1 9039. -#> 6 model 1979 Jun 1 9861. -#> 7 model 1979 Jul 1 11296. -#> 8 model 1979 Aug 1 9767. -#> 9 model 1979 Sep 1 9281. -#> 10 model 1979 Oct 1 9434. -#> # … with 230 more rows +#> .model .rep index .sim +#> <chr> <chr> <mth> <dbl> +#> 1 model 1 1979 Jan 8239. +#> 2 model 1 1979 Feb 8186. +#> 3 model 1 1979 Mar 8329. +#> 4 model 1 1979 Apr 8408. +#> 5 model 1 1979 May 8900. +#> 6 model 1 1979 Jun 9992. +#> 7 model 1 1979 Jul 11007. +#> 8 model 1 1979 Aug 10748. +#> 9 model 1 1979 Sep 9502. +#> 10 model 1 1979 Oct 10566. +#> # ℹ 230 more rows
@@ -141,7 +141,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/generate.ETS.html b/dev/reference/generate.ETS.html index a34c0ae4..d5836012 100644 --- a/dev/reference/generate.ETS.html +++ b/dev/reference/generate.ETS.html @@ -20,7 +20,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -86,11 +86,11 @@

Arguments

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

bootstrap
@@ -98,7 +98,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -113,19 +113,19 @@

Examples

generate(times = 100) #> # A tsibble: 2,400 x 4 [1M] #> # Key: .model, .rep [100] -#> .model index .rep .sim -#> <chr> <mth> <chr> <dbl> -#> 1 "ETS(log(value) ~ season(\"A\"))" 1979 Jan 1 8267. -#> 2 "ETS(log(value) ~ season(\"A\"))" 1979 Feb 1 7703. -#> 3 "ETS(log(value) ~ season(\"A\"))" 1979 Mar 1 8353. -#> 4 "ETS(log(value) ~ season(\"A\"))" 1979 Apr 1 8601. -#> 5 "ETS(log(value) ~ season(\"A\"))" 1979 May 1 9222. -#> 6 "ETS(log(value) ~ season(\"A\"))" 1979 Jun 1 10281. -#> 7 "ETS(log(value) ~ season(\"A\"))" 1979 Jul 1 11027. -#> 8 "ETS(log(value) ~ season(\"A\"))" 1979 Aug 1 10637. -#> 9 "ETS(log(value) ~ season(\"A\"))" 1979 Sep 1 9653. -#> 10 "ETS(log(value) ~ season(\"A\"))" 1979 Oct 1 9782. -#> # … with 2,390 more rows +#> .model .rep index .sim +#> <chr> <chr> <mth> <dbl> +#> 1 "ETS(log(value) ~ season(\"A\"))" 1 1979 Jan 8540. +#> 2 "ETS(log(value) ~ season(\"A\"))" 1 1979 Feb 7699. +#> 3 "ETS(log(value) ~ season(\"A\"))" 1 1979 Mar 8701. +#> 4 "ETS(log(value) ~ season(\"A\"))" 1 1979 Apr 8844. +#> 5 "ETS(log(value) ~ season(\"A\"))" 1 1979 May 10054. +#> 6 "ETS(log(value) ~ season(\"A\"))" 1 1979 Jun 10151. +#> 7 "ETS(log(value) ~ season(\"A\"))" 1 1979 Jul 10225. +#> 8 "ETS(log(value) ~ season(\"A\"))" 1 1979 Aug 10220. +#> 9 "ETS(log(value) ~ season(\"A\"))" 1 1979 Sep 8826. +#> 10 "ETS(log(value) ~ season(\"A\"))" 1 1979 Oct 8670. +#> # ℹ 2,390 more rows
@@ -140,7 +140,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/generate.NNETAR.html b/dev/reference/generate.NNETAR.html index 9c1d5416..f8bfe73e 100644 --- a/dev/reference/generate.NNETAR.html +++ b/dev/reference/generate.NNETAR.html @@ -20,7 +20,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -86,11 +86,11 @@

Arguments

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

bootstrap
@@ -98,7 +98,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -113,10 +113,10 @@

Examples

generate() #> # A tsibble: 2 x 4 [1Y] #> # Key: .model, .rep [1] -#> .model index .rep .sim -#> <chr> <dbl> <chr> <dbl> -#> 1 nn 1961 1 28818. -#> 2 nn 1962 1 41544. +#> .model .rep index .sim +#> <chr> <chr> <dbl> <dbl> +#> 1 nn 1 1961 33926. +#> 2 nn 1 1962 34189.
@@ -131,7 +131,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/generate.RW.html b/dev/reference/generate.RW.html index 33671599..d3d83abd 100644 --- a/dev/reference/generate.RW.html +++ b/dev/reference/generate.RW.html @@ -20,7 +20,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -86,7 +86,7 @@

Arguments

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

bootstrap
@@ -94,7 +94,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -109,27 +109,27 @@

Examples

generate() #> # A tsibble: 2 x 4 [1Y] #> # Key: .model, .rep [1] -#> .model index .rep .sim -#> <chr> <dbl> <chr> <dbl> -#> 1 NAIVE(value) 1971 1 913. -#> 2 NAIVE(value) 1972 1 1070. +#> .model .rep index .sim +#> <chr> <chr> <dbl> <dbl> +#> 1 NAIVE(value) 1 1971 685. +#> 2 NAIVE(value) 1 1972 881. library(tsibbledata) aus_production %>% - model(snaive = SNAIVE(Beer ~ lag("year"))) %>% + model(snaive = SNAIVE(Beer ~ lag("year"))) %>% generate() #> # A tsibble: 8 x 4 [1Q] #> # Key: .model, .rep [1] -#> .model Quarter .rep .sim -#> <chr> <qtr> <chr> <dbl> -#> 1 snaive 2010 Q3 1 424. -#> 2 snaive 2010 Q4 1 528. -#> 3 snaive 2011 Q1 1 404. -#> 4 snaive 2011 Q2 1 391. -#> 5 snaive 2011 Q3 1 430. -#> 6 snaive 2011 Q4 1 535. -#> 7 snaive 2012 Q1 1 410. -#> 8 snaive 2012 Q2 1 429. +#> .model .rep Quarter .sim +#> <chr> <chr> <qtr> <dbl> +#> 1 snaive 1 2010 Q3 402. +#> 2 snaive 1 2010 Q4 507. +#> 3 snaive 1 2011 Q1 412. +#> 4 snaive 1 2011 Q2 346. +#> 5 snaive 1 2011 Q3 402. +#> 6 snaive 1 2011 Q4 466. +#> 7 snaive 1 2012 Q1 443. +#> 8 snaive 1 2012 Q2 357.
@@ -144,7 +144,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/generate.TSLM.html b/dev/reference/generate.TSLM.html index 199783a8..d141fdfc 100644 --- a/dev/reference/generate.TSLM.html +++ b/dev/reference/generate.TSLM.html @@ -20,7 +20,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -86,11 +86,11 @@

Arguments

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

bootstrap
@@ -98,7 +98,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -111,21 +111,21 @@

Examples

as_tsibble(USAccDeaths) %>%
   model(lm = TSLM(log(value) ~ trend() + season())) %>%
   generate()
-#> # A tsibble: 24 x 3 [1M]
-#> # Key:       .model [1]
-#>    .model    index  .sim
-#>    <chr>     <mth> <dbl>
-#>  1 lm     1979 Jan 7592.
-#>  2 lm     1979 Feb 6885.
-#>  3 lm     1979 Mar 7577.
-#>  4 lm     1979 Apr 7820.
-#>  5 lm     1979 May 8587.
-#>  6 lm     1979 Jun 8955.
-#>  7 lm     1979 Jul 9937.
-#>  8 lm     1979 Aug 9181.
-#>  9 lm     1979 Sep 8166.
-#> 10 lm     1979 Oct 8494.
-#> # … with 14 more rows
+#> # A tsibble: 24 x 4 [1M]
+#> # Key:       .model, .rep [1]
+#>    .model .rep     index   .sim
+#>    <chr>  <chr>    <mth>  <dbl>
+#>  1 lm     1     1979 Jan  7607.
+#>  2 lm     1     1979 Feb  6645.
+#>  3 lm     1     1979 Mar  7800.
+#>  4 lm     1     1979 Apr  7849.
+#>  5 lm     1     1979 May  8109.
+#>  6 lm     1     1979 Jun  9329.
+#>  7 lm     1     1979 Jul 10041.
+#>  8 lm     1     1979 Aug  9034.
+#>  9 lm     1     1979 Sep  7585.
+#> 10 lm     1     1979 Oct  8631.
+#> # ℹ 14 more rows
 
@@ -140,7 +140,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/generate.model_mean.html b/dev/reference/generate.model_mean.html index 1cec699e..62f73314 100644 --- a/dev/reference/generate.model_mean.html +++ b/dev/reference/generate.model_mean.html @@ -20,7 +20,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -86,7 +86,7 @@

Arguments

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

bootstrap
@@ -94,7 +94,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -110,12 +110,12 @@

Examples

generate() #> # A tsibble: 4 x 4 [30m] <Australia/Melbourne> #> # Key: .model, .rep [1] -#> .model Time .rep .sim -#> <chr> <dttm> <chr> <dbl> -#> 1 avg 2015-01-01 00:00:00 1 4964. -#> 2 avg 2015-01-01 00:30:00 1 3579. -#> 3 avg 2015-01-01 01:00:00 1 4535. -#> 4 avg 2015-01-01 01:30:00 1 5217. +#> .model .rep Time .sim +#> <chr> <chr> <dttm> <dbl> +#> 1 avg 1 2015-01-01 00:00:00 5425. +#> 2 avg 1 2015-01-01 00:30:00 4485. +#> 3 avg 1 2015-01-01 01:00:00 4731. +#> 4 avg 1 2015-01-01 01:30:00 2698.
@@ -130,7 +130,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/glance.AR.html b/dev/reference/glance.AR.html index 3bd38867..1b8abab4 100644 --- a/dev/reference/glance.AR.html +++ b/dev/reference/glance.AR.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -118,7 +118,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/glance.ARIMA.html b/dev/reference/glance.ARIMA.html index f2e92c8e..672682e9 100644 --- a/dev/reference/glance.ARIMA.html +++ b/dev/reference/glance.ARIMA.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -136,7 +136,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/glance.ETS.html b/dev/reference/glance.ETS.html index cd6e729d..b91fe77b 100644 --- a/dev/reference/glance.ETS.html +++ b/dev/reference/glance.ETS.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -118,7 +118,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/glance.NNETAR.html b/dev/reference/glance.NNETAR.html index 17523cac..008b0095 100644 --- a/dev/reference/glance.NNETAR.html +++ b/dev/reference/glance.NNETAR.html @@ -18,7 +18,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -115,7 +115,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/glance.RW.html b/dev/reference/glance.RW.html index d2bd6468..f3203581 100644 --- a/dev/reference/glance.RW.html +++ b/dev/reference/glance.RW.html @@ -18,7 +18,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -104,7 +104,7 @@

Examples

library(tsibbledata) aus_production %>% - model(snaive = SNAIVE(Beer ~ lag("year"))) %>% + model(snaive = SNAIVE(Beer ~ lag("year"))) %>% glance() #> # A tibble: 1 × 2 #> .model sigma2 @@ -124,7 +124,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/glance.TSLM.html b/dev/reference/glance.TSLM.html index 2203e5b4..9c71f6df 100644 --- a/dev/reference/glance.TSLM.html +++ b/dev/reference/glance.TSLM.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -101,12 +101,11 @@

Examples

model(lm = TSLM(log(value) ~ trend() + season())) %>% glance() #> # A tibble: 1 × 15 -#> .model r_squared adj_r_sq…¹ sigma2 stati…² p_value df log_lik AIC AICc -#> <chr> <dbl> <dbl> <dbl> <dbl> <dbl> <int> <dbl> <dbl> <dbl> -#> 1 lm 0.825 0.789 0.00248 23.1 6.02e-18 13 121. -418. -411. -#> # … with 5 more variables: BIC <dbl>, CV <dbl>, deviance <dbl>, -#> # df.residual <int>, rank <int>, and abbreviated variable names -#> # ¹​adj_r_squared, ²​statistic +#> .model r_squared adj_r_squared sigma2 statistic p_value df log_lik AIC +#> <chr> <dbl> <dbl> <dbl> <dbl> <dbl> <int> <dbl> <dbl> +#> 1 lm 0.825 0.789 0.00248 23.1 6.02e-18 13 121. -418. +#> # ℹ 6 more variables: AICc <dbl>, BIC <dbl>, CV <dbl>, deviance <dbl>, +#> # df.residual <int>, rank <int>
@@ -121,7 +120,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/glance.VAR.html b/dev/reference/glance.VAR.html index 6239ba13..c5b5c91a 100644 --- a/dev/reference/glance.VAR.html +++ b/dev/reference/glance.VAR.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -121,7 +121,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/glance.fable_theta.html b/dev/reference/glance.fable_theta.html index f3a5acec..7cbb43f5 100644 --- a/dev/reference/glance.fable_theta.html +++ b/dev/reference/glance.fable_theta.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -106,7 +106,7 @@

Details

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/glance.model_mean.html b/dev/reference/glance.model_mean.html index 7237c470..b32218d0 100644 --- a/dev/reference/glance.model_mean.html +++ b/dev/reference/glance.model_mean.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -118,7 +118,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/index.html b/dev/reference/index.html index 4d1c0d75..85e3e152 100644 --- a/dev/reference/index.html +++ b/dev/reference/index.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -483,7 +483,7 @@

Vector autoregression -

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/interpolate.ARIMA.html b/dev/reference/interpolate.ARIMA.html index 69ce1966..fd37a9e7 100644 --- a/dev/reference/interpolate.ARIMA.html +++ b/dev/reference/interpolate.ARIMA.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,19 +76,19 @@

Interpolate missing values from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -119,7 +119,7 @@

Examples

#> 8 100 men 1924 10.6 #> 9 100 men 1928 10.8 #> 10 100 men 1932 10.3 -#> # … with 302 more rows +#> # ℹ 302 more rows
@@ -134,7 +134,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/interpolate.TSLM.html b/dev/reference/interpolate.TSLM.html index 9b758e80..79d90936 100644 --- a/dev/reference/interpolate.TSLM.html +++ b/dev/reference/interpolate.TSLM.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,19 +76,19 @@

Interpolate missing values from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -119,7 +119,7 @@

Examples

#> 8 100 men 1924 10.6 #> 9 100 men 1928 10.8 #> 10 100 men 1932 10.3 -#> # … with 302 more rows +#> # ℹ 302 more rows
@@ -134,7 +134,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/interpolate.model_mean.html b/dev/reference/interpolate.model_mean.html index 0b05eb25..2e166d87 100644 --- a/dev/reference/interpolate.model_mean.html +++ b/dev/reference/interpolate.model_mean.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,19 +76,19 @@

Interpolate missing values from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -119,7 +119,7 @@

Examples

#> 8 100 men 1924 10.6 #> 9 100 men 1928 10.8 #> 10 100 men 1932 10.3 -#> # … with 302 more rows +#> # ℹ 302 more rows
@@ -134,7 +134,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/reexports.html b/dev/reference/reexports.html index 2b4a2aef..542e52ba 100644 --- a/dev/reference/reexports.html +++ b/dev/reference/reexports.html @@ -28,7 +28,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -102,7 +102,7 @@

Objects exported from other packages

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/refit.AR.html b/dev/reference/refit.AR.html index 32d9d643..fd95fe71 100644 --- a/dev/reference/refit.AR.html +++ b/dev/reference/refit.AR.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,15 +76,15 @@

Refit an AR model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

reestimate
@@ -92,7 +92,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -151,7 +151,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/refit.ARIMA.html b/dev/reference/refit.ARIMA.html index ba22acab..2497f746 100644 --- a/dev/reference/refit.ARIMA.html +++ b/dev/reference/refit.ARIMA.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,15 +76,15 @@

Refit an ARIMA model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

reestimate
@@ -92,7 +92,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -149,7 +149,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/refit.ETS.html b/dev/reference/refit.ETS.html index db0b0ace..e530705e 100644 --- a/dev/reference/refit.ETS.html +++ b/dev/reference/refit.ETS.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -83,15 +83,15 @@

Refit an ETS model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

reestimate
@@ -103,7 +103,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -168,7 +168,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/refit.NNETAR.html b/dev/reference/refit.NNETAR.html index ceefab75..c5e52443 100644 --- a/dev/reference/refit.NNETAR.html +++ b/dev/reference/refit.NNETAR.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,15 +76,15 @@

Refit a NNETAR model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

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

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -121,7 +121,7 @@

Examples

#> a 4-2-1 network with 13 weights #> options were - linear output units #> -#> sigma^2 estimated as 22257 +#> sigma^2 estimated as 21523 fit %>% refit(new_data = lung_deaths_female, reestimate = FALSE) %>% @@ -133,7 +133,7 @@

Examples

#> a 4-2-1 network with 13 weights #> options were - linear output units #> -#> sigma^2 estimated as 205669 +#> sigma^2 estimated as 236049
@@ -148,7 +148,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/refit.RW.html b/dev/reference/refit.RW.html index 937e89be..72851042 100644 --- a/dev/reference/refit.RW.html +++ b/dev/reference/refit.RW.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,15 +76,15 @@

Refit a lag walk model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

reestimate
@@ -93,7 +93,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -140,7 +140,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/refit.TSLM.html b/dev/reference/refit.TSLM.html index 0e6bdef0..3b3ca7ed 100644 --- a/dev/reference/refit.TSLM.html +++ b/dev/reference/refit.TSLM.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,15 +76,15 @@

Refit a TSLM

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

reestimate
@@ -92,7 +92,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -179,7 +179,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/refit.model_mean.html b/dev/reference/refit.model_mean.html index 4a943d15..f7db3e9e 100644 --- a/dev/reference/refit.model_mean.html +++ b/dev/reference/refit.model_mean.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,15 +76,15 @@

Refit a MEAN model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

new_data
-

A tsibble containing future information used to forecast.

+

A tsibble containing the time points and exogenous regressors to produce forecasts for.

specials
-

(passed by fabletools::forecast.mdl_df()).

+

(passed by fabletools::forecast.mdl_df()).

reestimate
@@ -93,7 +93,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -134,7 +134,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/residuals.AR.html b/dev/reference/residuals.AR.html index cd9289a0..e4736f02 100644 --- a/dev/reference/residuals.AR.html +++ b/dev/reference/residuals.AR.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,7 +76,7 @@

Extract residuals from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

type
@@ -84,7 +84,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -113,7 +113,7 @@

Examples

#> 8 AR(value ~ order(3)) 8 -0.159 #> 9 AR(value ~ order(3)) 9 -0.0469 #> 10 AR(value ~ order(3)) 10 -0.491 -#> # … with 38 more rows +#> # ℹ 38 more rows
@@ -128,7 +128,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/residuals.ARIMA.html b/dev/reference/residuals.ARIMA.html index 826ecb9f..47a00979 100644 --- a/dev/reference/residuals.ARIMA.html +++ b/dev/reference/residuals.ARIMA.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,7 +76,7 @@

Extract residuals from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

type
@@ -84,7 +84,7 @@

Arguments

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -114,7 +114,7 @@

Examples

#> 8 arima 1973 Aug 0.000683 #> 9 arima 1973 Sep 0.000512 #> 10 arima 1973 Oct 0.000482 -#> # … with 62 more rows +#> # ℹ 62 more rows
@@ -129,7 +129,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/residuals.ETS.html b/dev/reference/residuals.ETS.html index edce808a..a83385d4 100644 --- a/dev/reference/residuals.ETS.html +++ b/dev/reference/residuals.ETS.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,11 +76,11 @@

Extract residuals from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -109,7 +109,7 @@

Examples

#> 8 ets 1973 Aug 0.00863 #> 9 ets 1973 Sep 0.0196 #> 10 ets 1973 Oct 0.00108 -#> # … with 62 more rows +#> # ℹ 62 more rows
@@ -124,7 +124,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/residuals.NNETAR.html b/dev/reference/residuals.NNETAR.html index 433a05ae..bc90cdab 100644 --- a/dev/reference/residuals.NNETAR.html +++ b/dev/reference/residuals.NNETAR.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,11 +76,11 @@

Extract residuals from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -100,16 +100,16 @@

Examples

#> .model index .resid #> <chr> <dbl> <dbl> #> 1 nn 1937 NA -#> 2 nn 1938 -0.440 -#> 3 nn 1939 0.112 -#> 4 nn 1940 0.420 -#> 5 nn 1941 0.0530 -#> 6 nn 1942 -0.670 -#> 7 nn 1943 -0.314 -#> 8 nn 1944 0.151 -#> 9 nn 1945 0.676 +#> 2 nn 1938 -0.444 +#> 3 nn 1939 0.110 +#> 4 nn 1940 0.421 +#> 5 nn 1941 0.0557 +#> 6 nn 1942 -0.666 +#> 7 nn 1943 -0.310 +#> 8 nn 1944 0.155 +#> 9 nn 1945 0.680 #> 10 nn 1946 1.26 -#> # … with 14 more rows +#> # ℹ 14 more rows
@@ -124,7 +124,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/residuals.RW.html b/dev/reference/residuals.RW.html index ec0511a6..e2d556e5 100644 --- a/dev/reference/residuals.RW.html +++ b/dev/reference/residuals.RW.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,11 +76,11 @@

Extract residuals from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -109,11 +109,11 @@

Examples

#> 8 NAIVE(value) 1878 417 #> 9 NAIVE(value) 1879 140 #> 10 NAIVE(value) 1880 -230 -#> # … with 90 more rows +#> # ℹ 90 more rows library(tsibbledata) aus_production %>% - model(snaive = SNAIVE(Beer ~ lag("year"))) %>% + model(snaive = SNAIVE(Beer ~ lag("year"))) %>% residuals() #> # A tsibble: 218 x 3 [1Q] #> # Key: .model [1] @@ -129,7 +129,7 @@

Examples

#> 8 snaive 1957 Q4 12 #> 9 snaive 1958 Q1 10 #> 10 snaive 1958 Q2 5 -#> # … with 208 more rows +#> # ℹ 208 more rows
@@ -144,7 +144,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/residuals.TSLM.html b/dev/reference/residuals.TSLM.html index 503096f6..c29a1e52 100644 --- a/dev/reference/residuals.TSLM.html +++ b/dev/reference/residuals.TSLM.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,11 +76,11 @@

Extract residuals from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -109,7 +109,7 @@

Examples

#> 8 lm 1973 Aug 0.0598 #> 9 lm 1973 Sep 0.0735 #> 10 lm 1973 Oct 0.0630 -#> # … with 62 more rows +#> # ℹ 62 more rows
@@ -124,7 +124,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/residuals.VAR.html b/dev/reference/residuals.VAR.html index 83d14fa1..b0acd7a9 100644 --- a/dev/reference/residuals.VAR.html +++ b/dev/reference/residuals.VAR.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,11 +76,11 @@

Extract residuals from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -112,7 +112,7 @@

Examples

#> 8 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1974 Aug -291. -112. #> 9 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1974 Sep -102. -83.7 #> 10 VAR(vars(mdeaths, fdeaths) ~ AR(3)) 1974 Oct 150. 102. -#> # … with 62 more rows +#> # ℹ 62 more rows
@@ -127,7 +127,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/residuals.croston.html b/dev/reference/residuals.croston.html index f496a04b..05b42449 100644 --- a/dev/reference/residuals.croston.html +++ b/dev/reference/residuals.croston.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,11 +76,11 @@

Extract residuals from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -107,16 +107,16 @@

Examples

#> .model time .resid #> <chr> <mth> <dbl> #> 1 CROSTON(count) 2013 Jan NA -#> 2 CROSTON(count) 2013 Feb 0.478 -#> 3 CROSTON(count) 2013 Mar -0.522 -#> 4 CROSTON(count) 2013 Apr -0.522 -#> 5 CROSTON(count) 2013 May 0.478 -#> 6 CROSTON(count) 2013 Jun -0.522 -#> 7 CROSTON(count) 2013 Jul -0.522 -#> 8 CROSTON(count) 2013 Aug 0.478 -#> 9 CROSTON(count) 2013 Sep -0.522 -#> 10 CROSTON(count) 2013 Oct 0.478 -#> # … with 14 more rows +#> 2 CROSTON(count) 2013 Feb -0.336 +#> 3 CROSTON(count) 2013 Mar -0.336 +#> 4 CROSTON(count) 2013 Apr -0.336 +#> 5 CROSTON(count) 2013 May -0.336 +#> 6 CROSTON(count) 2013 Jun 1.66 +#> 7 CROSTON(count) 2013 Jul -0.396 +#> 8 CROSTON(count) 2013 Aug -0.396 +#> 9 CROSTON(count) 2013 Sep 0.604 +#> 10 CROSTON(count) 2013 Oct 0.582 +#> # ℹ 14 more rows
@@ -131,7 +131,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/residuals.fable_theta.html b/dev/reference/residuals.fable_theta.html index ab6552a8..aceadc76 100644 --- a/dev/reference/residuals.fable_theta.html +++ b/dev/reference/residuals.fable_theta.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,11 +76,11 @@

Extract residuals from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -110,7 +110,7 @@

Examples

#> 8 avg 2012-01-01 03:30:00 -1104. #> 9 avg 2012-01-01 04:00:00 -1232. #> 10 avg 2012-01-01 04:30:00 -1306. -#> # … with 52,598 more rows +#> # ℹ 52,598 more rows
@@ -125,7 +125,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/residuals.model_mean.html b/dev/reference/residuals.model_mean.html index e8734855..036be685 100644 --- a/dev/reference/residuals.model_mean.html +++ b/dev/reference/residuals.model_mean.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -76,11 +76,11 @@

Extract residuals from a fable model

Arguments

object
-

The time series model used to produce the forecasts

+

A model for which forecasts are required.

...
-

Additional arguments for forecast model methods.

+

Other arguments passed to methods

@@ -110,7 +110,7 @@

Examples

#> 8 avg 2012-01-01 03:30:00 -1104. #> 9 avg 2012-01-01 04:00:00 -1232. #> 10 avg 2012-01-01 04:30:00 -1306. -#> # … with 52,598 more rows +#> # ℹ 52,598 more rows
@@ -125,7 +125,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/tidy.AR.html b/dev/reference/tidy.AR.html index cfc934e2..7694ce03 100644 --- a/dev/reference/tidy.AR.html +++ b/dev/reference/tidy.AR.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -70,7 +70,7 @@

Tidy a fable model

# S3 method for AR
-tidy(x)
+tidy(x, ...)
@@ -78,6 +78,10 @@

Arguments

x

An object to be converted into a tidy tibble::tibble().

+ +
...
+

Additional arguments to tidying method.

+

Value

@@ -112,7 +116,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/tidy.ARIMA.html b/dev/reference/tidy.ARIMA.html index 5c7ad483..9655e817 100644 --- a/dev/reference/tidy.ARIMA.html +++ b/dev/reference/tidy.ARIMA.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -115,7 +115,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/tidy.ETS.html b/dev/reference/tidy.ETS.html index c672fa1a..d12ce951 100644 --- a/dev/reference/tidy.ETS.html +++ b/dev/reference/tidy.ETS.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -129,7 +129,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/tidy.NNETAR.html b/dev/reference/tidy.NNETAR.html index 2bd9d0b8..78458859 100644 --- a/dev/reference/tidy.NNETAR.html +++ b/dev/reference/tidy.NNETAR.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -96,7 +96,7 @@

Examples

model(nn = NNETAR(box_cox(value, 0.15))) %>% tidy() #> # A tibble: 0 × 1 -#> # … with 1 variable: .model <chr> +#> # ℹ 1 variable: .model <chr>
@@ -111,7 +111,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/tidy.RW.html b/dev/reference/tidy.RW.html index 5bd2759f..9b482c5f 100644 --- a/dev/reference/tidy.RW.html +++ b/dev/reference/tidy.RW.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -96,16 +96,16 @@

Examples

model(NAIVE(value)) %>% tidy() #> # A tibble: 0 × 6 -#> # … with 6 variables: .model <chr>, term <chr>, estimate <dbl>, -#> # std.error <dbl>, statistic <dbl>, p.value <dbl> +#> # ℹ 6 variables: .model <chr>, term <chr>, estimate <dbl>, std.error <dbl>, +#> # statistic <dbl>, p.value <dbl> library(tsibbledata) aus_production %>% - model(snaive = SNAIVE(Beer ~ lag("year"))) %>% + model(snaive = SNAIVE(Beer ~ lag("year"))) %>% tidy() #> # A tibble: 0 × 6 -#> # … with 6 variables: .model <chr>, term <chr>, estimate <dbl>, -#> # std.error <dbl>, statistic <dbl>, p.value <dbl> +#> # ℹ 6 variables: .model <chr>, term <chr>, estimate <dbl>, std.error <dbl>, +#> # statistic <dbl>, p.value <dbl>
@@ -120,7 +120,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/tidy.TSLM.html b/dev/reference/tidy.TSLM.html index 56a7568c..4f110ff7 100644 --- a/dev/reference/tidy.TSLM.html +++ b/dev/reference/tidy.TSLM.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -125,7 +125,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/tidy.VAR.html b/dev/reference/tidy.VAR.html index 85727bf0..dc54bd5c 100644 --- a/dev/reference/tidy.VAR.html +++ b/dev/reference/tidy.VAR.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -70,7 +70,7 @@

Tidy a fable model

# S3 method for VAR
-tidy(x)
+tidy(x, ...)
@@ -78,6 +78,10 @@

Arguments

x

An object to be converted into a tidy tibble::tibble().

+ +
...
+

Additional arguments to tidying method.

+

Value

@@ -95,23 +99,22 @@

Examples

model(VAR(vars(mdeaths, fdeaths) ~ AR(3))) %>% tidy() #> # A tibble: 14 × 7 -#> .model term .resp…¹ estimate std.e…² stati…³ p.value -#> <chr> <chr> <chr> <dbl> <dbl> <dbl> <dbl> -#> 1 VAR(vars(mdeaths, fdeaths) ~ … lag(… mdeaths 0.667 0.355 1.88 6.48e-2 -#> 2 VAR(vars(mdeaths, fdeaths) ~ … lag(… mdeaths 0.807 0.835 0.967 3.37e-1 -#> 3 VAR(vars(mdeaths, fdeaths) ~ … lag(… mdeaths 0.368 0.352 1.04 3.01e-1 -#> 4 VAR(vars(mdeaths, fdeaths) ~ … lag(… mdeaths -1.45 0.809 -1.80 7.71e-2 -#> 5 VAR(vars(mdeaths, fdeaths) ~ … lag(… mdeaths 0.261 0.342 0.761 4.50e-1 -#> 6 VAR(vars(mdeaths, fdeaths) ~ … lag(… mdeaths -1.12 0.814 -1.38 1.73e-1 -#> 7 VAR(vars(mdeaths, fdeaths) ~ … cons… mdeaths 539. 137. 3.93 2.17e-4 -#> 8 VAR(vars(mdeaths, fdeaths) ~ … lag(… fdeaths 0.214 0.146 1.46 1.48e-1 -#> 9 VAR(vars(mdeaths, fdeaths) ~ … lag(… fdeaths 0.456 0.343 1.33 1.89e-1 -#> 10 VAR(vars(mdeaths, fdeaths) ~ … lag(… fdeaths 0.0937 0.145 0.646 5.20e-1 -#> 11 VAR(vars(mdeaths, fdeaths) ~ … lag(… fdeaths -0.398 0.333 -1.20 2.36e-1 -#> 12 VAR(vars(mdeaths, fdeaths) ~ … lag(… fdeaths 0.0250 0.141 0.178 8.60e-1 -#> 13 VAR(vars(mdeaths, fdeaths) ~ … lag(… fdeaths -0.315 0.335 -0.940 3.51e-1 -#> 14 VAR(vars(mdeaths, fdeaths) ~ … cons… fdeaths 202. 56.4 3.58 6.72e-4 -#> # … with abbreviated variable names ¹​.response, ²​std.error, ³​statistic +#> .model term .response estimate std.error statistic p.value +#> <chr> <chr> <chr> <dbl> <dbl> <dbl> <dbl> +#> 1 VAR(vars(mdeaths, fdeat… lag(… mdeaths 0.667 0.355 1.88 6.48e-2 +#> 2 VAR(vars(mdeaths, fdeat… lag(… mdeaths 0.807 0.835 0.967 3.37e-1 +#> 3 VAR(vars(mdeaths, fdeat… lag(… mdeaths 0.368 0.352 1.04 3.01e-1 +#> 4 VAR(vars(mdeaths, fdeat… lag(… mdeaths -1.45 0.809 -1.80 7.71e-2 +#> 5 VAR(vars(mdeaths, fdeat… lag(… mdeaths 0.261 0.342 0.761 4.50e-1 +#> 6 VAR(vars(mdeaths, fdeat… lag(… mdeaths -1.12 0.814 -1.38 1.73e-1 +#> 7 VAR(vars(mdeaths, fdeat… cons… mdeaths 539. 137. 3.93 2.17e-4 +#> 8 VAR(vars(mdeaths, fdeat… lag(… fdeaths 0.214 0.146 1.46 1.48e-1 +#> 9 VAR(vars(mdeaths, fdeat… lag(… fdeaths 0.456 0.343 1.33 1.89e-1 +#> 10 VAR(vars(mdeaths, fdeat… lag(… fdeaths 0.0937 0.145 0.646 5.20e-1 +#> 11 VAR(vars(mdeaths, fdeat… lag(… fdeaths -0.398 0.333 -1.20 2.36e-1 +#> 12 VAR(vars(mdeaths, fdeat… lag(… fdeaths 0.0250 0.141 0.178 8.60e-1 +#> 13 VAR(vars(mdeaths, fdeat… lag(… fdeaths -0.315 0.335 -0.940 3.51e-1 +#> 14 VAR(vars(mdeaths, fdeat… cons… fdeaths 202. 56.4 3.58 6.72e-4
@@ -126,7 +129,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/tidy.croston.html b/dev/reference/tidy.croston.html index 2a107fdc..423c407c 100644 --- a/dev/reference/tidy.croston.html +++ b/dev/reference/tidy.croston.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -105,10 +105,10 @@

Examples

#> # A tibble: 4 × 3 #> .model term estimate #> <chr> <chr> <dbl> -#> 1 CROSTON(count) demand_init 0.383 -#> 2 CROSTON(count) demand_par 0 -#> 3 CROSTON(count) interval_init 1 -#> 4 CROSTON(count) interval_par 0.0995 +#> 1 CROSTON(count) demand_init 0.965 +#> 2 CROSTON(count) demand_par 0 +#> 3 CROSTON(count) interval_init 3.86 +#> 4 CROSTON(count) interval_par 0
@@ -123,7 +123,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/tidy.fable_theta.html b/dev/reference/tidy.fable_theta.html index 326f241b..ed3e868b 100644 --- a/dev/reference/tidy.fable_theta.html +++ b/dev/reference/tidy.fable_theta.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -115,7 +115,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/tidy.model_mean.html b/dev/reference/tidy.model_mean.html index 047b65c7..8335409e 100644 --- a/dev/reference/tidy.model_mean.html +++ b/dev/reference/tidy.model_mean.html @@ -17,7 +17,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -114,7 +114,7 @@

Examples

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.

diff --git a/dev/reference/unitroot_options.html b/dev/reference/unitroot_options.html index 56722dcc..3a652156 100644 --- a/dev/reference/unitroot_options.html +++ b/dev/reference/unitroot_options.html @@ -20,7 +20,7 @@ fable - 0.3.2.9000 + 0.3.3.9000 @@ -114,7 +114,7 @@

Value

-

Site built with pkgdown 2.0.6.

+

Site built with pkgdown 2.0.7.