diff --git a/.Rbuildignore b/.Rbuildignore index 0a12514fec46363d65b755d260f626eadb38f7be..3bfb96842c63b284cf0194d4f66d51656f366519 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -11,4 +11,5 @@ ^tests ^misc-R$ ^.*\.Rhistory$ -^cran-comments.md \ No newline at end of file +^cran-comments.md +^README\.Rmd$ diff --git a/README.Rmd b/README.Rmd new file mode 100644 index 0000000000000000000000000000000000000000..32e3811e9dc7573f6e5852e8c16732b0d477d32f --- /dev/null +++ b/README.Rmd @@ -0,0 +1,44 @@ +--- +output: github_document +--- +<!---usethis::use_readme_rmd() --> +<!-- README.md is generated from README.Rmd. Please edit that file --> + +```{r, include = FALSE} +knitr::opts_chunk$set( + collapse = TRUE, + comment = "#>", + fig.path = "man/figures/README-", + out.width = "100%" +) +``` + +# onlineforecast +<!-- +usethis::use_cran_badge() +usethis::use_lifecycle_badge("stable") +--> + + +<!-- badges: start --> +[](https://CRAN.R-project.org/package=onlineforecast) +[](https://www.tidyverse.org/lifecycle/#stable) +[](https://cran.r-project.org/package=onlineforecast) +<!-- badges: end --> + + +The *onlineforecast* R package computes new forecasts whenever new observations becomes available by using recursive estimation. The package makes it easy to setup models to be used for online forecasting, where the user can create their own online forecast-set-up with their own inputs. The pacakge is created based on the authors long experience of formulating time series models which use weather forecasts as inputs. The challenge comes from the overlapping time series as the forecast needs to be updated whenever the weather forecast is updated. + +See more on [onlineforecast](https://onlineforecasting.org/) webpage + +## Installation + +You can install the released version of onlineforecast from [CRAN](https://CRAN.R-project.org) with: + +``` r +install.packages("onlineforecast") +``` + +## Example + +See examples on how to use the package on the website, [onlineforecast](https://onlineforecasting.org/examples.html) where multiple vignettes demonstrate how it works. diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..53b6eb80f711e018ec79f5dec6f4537f8146fffb --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ + +<!---usethis::use_readme_rmd() --> + +<!-- README.md is generated from README.Rmd. Please edit that file --> + +# onlineforecast + +<!-- +usethis::use_cran_badge() +usethis::use_lifecycle_badge("stable") +--> + +<!-- badges: start --> + +[](https://CRAN.R-project.org/package=onlineforecast) +[](https://www.tidyverse.org/lifecycle/#stable) +[](https://cran.r-project.org/package=onlineforecast) +<!-- badges: end --> + +The *onlineforecast* R package computes new forecasts whenever new +observations becomes available by using recursive estimation. The +package makes it easy to setup models to be used for online forecasting, +where the user can create their own online forecast-set-up with their +own inputs. The pacakge is created based on the authors long experience +of formulating time series models which use weather forecasts as inputs. +The challenge comes from the overlapping time series as the forecast +needs to be updated whenever the weather forecast is updated. + +See more on [onlineforecast](https://onlineforecasting.org/) webpage + +## Installation + +You can install the released version of onlineforecast from +[CRAN](https://CRAN.R-project.org) with: + +``` r +install.packages("onlineforecast") +``` + +## Example + +See examples on how to use the package on the website, +[onlineforecast](https://onlineforecasting.org/examples.html) where +multiple vignettes demonstrate how it works.