From 80ee0360f44ad5120118e20aade5f8514a946762 Mon Sep 17 00:00:00 2001 From: earowang Date: Sun, 25 Mar 2018 17:26:49 +1100 Subject: [PATCH] updated readme --- Makefile | 5 ++- README.md | 47 +++++++++++++----------- docs/news/index.html | 85 ++++++++++++++++++++++---------------------- 3 files changed, 73 insertions(+), 64 deletions(-) diff --git a/Makefile b/Makefile index 9e520c9..9901f97 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,9 @@ document: Rscript -e "devtools::document()" +readme: + Rscript -e "rmarkdown::render('README.Rmd'); pkgdown::build_home()" + build: Rscript -e "devtools::build()" @@ -20,4 +23,4 @@ release: Rscript -e "devtools::release()" pkgdown: - Rscript -e "library(pkgdown); clean_site(); init_site(); build_home(); build_reference(run_dont_run = TRUE); build_news()" + Rscript -e "pkgdown::build_site(run_dont_run = TRUE)" diff --git a/README.md b/README.md index 2f3c317..dd38635 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,35 @@ -hts -=== -[![Travis-CI Build Status](https://travis-ci.org/earowang/hts.svg?branch=master)](https://travis-ci.org/earowang/hts) [![codecov](https://codecov.io/gh/earowang/hts/branch/master/graph/badge.svg)](https://codecov.io/gh/earowang/hts) [![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/hts)](https://cran.r-project.org/package=hts) [![Downloads](http://cranlogs.r-pkg.org/badges/hts)](https://cran.r-project.org/package=hts) +# hts -The R package *hts* presents functions to create, plot and forecast hierarchical and grouped time series. +[![Travis-CI Build +Status](https://travis-ci.org/earowang/hts.svg?branch=master)](https://travis-ci.org/earowang/hts) +[![codecov](https://codecov.io/gh/earowang/hts/branch/master/graph/badge.svg)](https://codecov.io/gh/earowang/hts) +[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/hts)](https://cran.r-project.org/package=hts) +[![Downloads](http://cranlogs.r-pkg.org/badges/hts)](https://cran.r-project.org/package=hts) -Installation ------------- +The R package *hts* presents functions to create, plot and forecast +hierarchical and grouped time series. -You can install the **stable** version on [R CRAN](https://cran.r-project.org/package=hts). +## Installation + +You can install the **stable** version on [R +CRAN](https://cran.r-project.org/package=hts). ``` r install.packages('hts', dependencies = TRUE) ``` -You can also install the **development** version from [Github](https://github.com/robjhyndman/gts) +You can also install the **development** version from +[Github](https://github.com/robjhyndman/gts) ``` r # install.packages("devtools") devtools::install_github("earowang/hts") ``` -Usage ------ +## Usage ### Example 1: hierarchical time series @@ -68,7 +73,7 @@ aggts3 <- aggts(htseg1, levels = c(0, 2)) plot(htseg1, levels = 1) ``` -![](man/figure/hts-eg1-1.png) +![](man/figure/hts-eg1-1.png) ``` r smatrix(htseg1) # Return the dense mode @@ -137,13 +142,13 @@ aggts4 <- aggts(fcasts1.comb) plot(fcasts1.comb, levels = 2) ``` -![](man/figure/hts-eg1-2.png) +![](man/figure/hts-eg1-2.png) ``` r plot(fcasts1.comb, include = 5, levels = c(1, 2)) ``` -![](man/figure/hts-eg1-3.png) +![](man/figure/hts-eg1-3.png) ### Example 2: hierarchical time series @@ -192,13 +197,13 @@ fcasts2.td <- forecast( plot(fcasts2.td, include = 5) ``` -![](man/figure/hts-eg2-1.png) +![](man/figure/hts-eg2-1.png) ``` r plot(fcasts2.td, include = 5, levels = c(0, 2)) ``` -![](man/figure/hts-eg2-2.png) +![](man/figure/hts-eg2-2.png) ### Example 3: grouped time series @@ -207,7 +212,7 @@ plot(fcasts2.td, include = 5, levels = c(0, 2)) plot(infantgts, levels = 1) ``` -![](man/figure/gts-eg-1.png) +![](man/figure/gts-eg-1.png) ``` r @@ -217,13 +222,13 @@ agg_gts2 <- aggts(fcasts3.comb, levels = 1, forecasts = FALSE) plot(fcasts3.comb) ``` -![](man/figure/gts-eg-2.png) +![](man/figure/gts-eg-2.png) ``` r plot(fcasts3.comb, include = 5, levels = c(1, 2)) ``` -![](man/figure/gts-eg-3.png) +![](man/figure/gts-eg-3.png) ``` r @@ -238,7 +243,7 @@ fcasts3.combn <- forecast( ) ``` -License -------- +## License -This package is free and open source software, licensed under GPL (>= 2). +This package is free and open source software, licensed under GPL (\>= +2). diff --git a/docs/news/index.html b/docs/news/index.html index 84af0ee..18ca1c1 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -90,11 +90,12 @@

  • Fixed hts authorship in the DESCRIPTION file
  • Updated reference
  • Replaced rBind with rbind due to Matrix new release
    • +
  • Depends on R (>= 3.2.0)
    • -
    +

    -hts 5.1.4 (20 Jun 2017) 2017-06-21 +hts 5.1.4 2017-06-21

    • The hts and gts don’t actually fit into mts, ts and matrix classes, and hence mts, ts and matrix classes are dropped.
      • @@ -103,9 +104,9 @@

    • Fixed forecast(FUN = hybridModel) when newxreg is present (#28).

    -
    +

    -hts 5.1.0 (18 Jun 2017) 2017-06-18 +hts 5.1.0 2017-06-18

    • Earo Wang took over maintenance of the package from Rob J Hyndman.
      • @@ -117,9 +118,9 @@

    • Registered accurary as an S3 method from forecast::accuracy.

    -
    +

    -hts 5.0 (April 2016) 2016-04-06 +hts 5.0 2016-04-06

    • Added mint option in forecast.gts (written by Shanika Wickramasuriya)
      • @@ -128,9 +129,9 @@

    • Bug fixes

    -
    +

    -hts 4.5 (17 June 2015) 2015-06-29 +hts 4.5 2015-06-29

    • Fixed bugs in accuracy.gts().
      • @@ -145,9 +146,9 @@

    • Fixed time attributes of fitted and residual series.

    -
    +

    -hts 4.4 (22 July 2014) 2014-07-23 +hts 4.4 2014-07-23

    • Allowed multiple seasonal objects “msts” in hts() and gts().
      • @@ -155,9 +156,9 @@

    • Allowed user’s defined forecasting function in forecast.gts().

    -
    +

    -hts 4.3 (10 June 2014) 2014-06-10 +hts 4.3 2014-06-10

    • Fixed bug of the arg “include” in plot.gts, when there are not yearly data.
      • @@ -168,18 +169,18 @@

    • Made ‘sd’ the default weight in forecast.gts().

    -
    +

    -hts 4.2 (25 Mar 2014) 2014-04-09 +hts 4.2 2014-04-09

    • Fixed Next.Generic error in accuracy.gts.
    • Adjust weights = sd.
    -
    +

    -hts 4.1 (3 Mar 2014) 2014-03-07 +hts 4.1 2014-03-07

    • Set the default parallel processes to 2.
      • @@ -187,9 +188,9 @@

    • Speeded up the topdown approaches.

    -
    +

    -hts 4.0 (10 Feb 2014) 2014-02-10 +hts 4.0 2014-02-10

    • Speeded up all existing functions.
      • @@ -209,18 +210,18 @@

    • Argument levels in plot.gts function allows more flexibilities.

    -
    +

    -hts 3.01 (7 May 2013) 2013-05-07 +hts 3.01 2013-05-07

    • Added the infantgts data
    • Added the vignette
    -
    +

    -hts 3.00 (7 March 2013) 2013-03-07 +hts 3.00 2013-03-07

    • Restructured gts objects and dropped hts objects. A flag indicates if gts is hierarchical.
      • @@ -230,25 +231,25 @@

    • Moved SparseM from Depends to Imports

    -
    +

    -hts 2.02 (3 November 2011) 2011-11-07 +hts 2.02 2011-11-07

    • Bug fixes to cope with much bigger hierarchies
    -
    +

    -hts 2.01 (3 November 2011) 2011-11-03 +hts 2.01 2011-11-03

    • Changed hierarchical naming convention to allow much bigger hierarchies.
    -
    +

    -hts 2.0 (2 September 2011) 2011-09-02 +hts 2.0 2011-09-02