Data

Tools

Indexes

Applications

Experiments

Open Source Science

smooth

The set of functions used for time series analysis and in forecasting.

https://github.com/config-i1/smooth

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 7 committers (14.3%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.1%) to scientific vocabulary

Keywords

arima arima-forecasting ces ets exponential-smoothing forecast r-package state-space statespace time-series
Last synced: 6 months ago · JSON representation

Repository

The set of functions used for time series analysis and in forecasting.

Basic Info
  • Host: GitHub
  • Owner: config-i1
  • Language: R
  • Default Branch: master
  • Homepage:
  • Size: 10 MB
Statistics
  • Stars: 93
  • Watchers: 5
  • Forks: 21
  • Open Issues: 11
  • Releases: 28
Topics
arima arima-forecasting ces ets exponential-smoothing forecast r-package state-space statespace time-series
Created about 10 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog

README.md

smooth

CRAN_Status_Badge Downloads R-CMD-check

The package smooth contains several smoothing (exponential and not) functions that are used in forecasting.

hex-sticker of the smooth package for R

Here is the list of the included functions:

  1. adam - Advanced Dynamic Adaptive Model, implementing ETS, ARIMA and regression and their combinations;
  2. es - the ETS function. It can handle exogenous variables and has a handy "holdout" parameter. There are several cost function implemented, including trace forecast based ones. Model selection is done via branch and bound algorithm and there's a possibility to use AIC weights in order to produce combined forecasts. Finally, all the possible ETS functions are implemented here.
  3. ces - Complex Exponential Smoothing. Function estimates CES and makes forecast. See documentation for details.
  4. gum - Generalised Exponential Smoothing. Next step from CES. The paper on this is in the process.
  5. sma - Simple Moving Average in state space form.
  6. ssarima - SARIMA estimated in state space framework.
  7. msarima - Multiple seasonal ARIMA, allows multiple seasonalities and works in a finite time.
  8. auto.ces - selection between seasonal and non-seasonal CES models.
  9. auto.ssarima - selection between different State-Space ARIMA models.
  10. auto.msarima - selection between different multiple SARIMA models.
  11. auto.gum - automatic selection of the most appropriate GUM model.
  12. sim.es - simulation of data using ETS framework with a predefined (or random) smoothing parameters and initial values.
  13. sim.ssarima - simulation of data using State-Space ARIMA framework with a predefined (or randomly generated) parameters and initial values.
  14. sim.ces - simulation of data using CES with a predefined (or random) complex smoothing parameters and initial values.
  15. sim.gum - simulation functions for GUM.
  16. sim.sma - simulates data from SMA.
  17. oes - occurrence state space exponential smoothing model. This function models the part with data occurrences using one of the following methods: fixed, odds ratio, inverse odds ratio, direct or general. It can also select the most appropriate between the five.
  18. sowhat - returns the ultimate answer to any question.
  19. smoothCombine - the function that combines forecasts from es(), ces(), gum(), ssarima() and sma() functions.
  20. cma - Centred Moving Average. This is the function used for smoothing of time series, not for forecasting.
  21. msdecompose - multiple seasonal decomposition based on centred moving averages.

Available methods:

  1. AIC, BIC, AICc, BICc;
  2. coefficients;
  3. multicov - covariance matrix of multiple steps ahead forecast errors;
  4. errorType - the type of the error in the model: either additive or multiplicative;
  5. fitted;
  6. forecast;
  7. actuals;
  8. lags - lags of the model (mainly needed for ARIMA and GUM);
  9. logLik;
  10. modelType - type of the estimated model (mainly needed for ETS and CES);
  11. nobs;
  12. nparam - number of the estimated parameters in the model;
  13. orders - orders of the components of the model (mainly needed for ARIMA, GUM and SMA);
  14. outlierdummy - creates a matrix of dummy variables, based on the detected outliers in the residuals of the model;
  15. residuals - the residuals of the model (et in case of additive and log(1+et) for the multiplicative ones);
  16. rstandard - standardised residuals;
  17. rstudent - studentised residuals;
  18. plot - produces several plots for diagnostics purposes. See the documentation for plot.smooth();
  19. pls - Prediction Likelihood Score for the model and the provided holdout;
  20. pointLik - the vector of the individual likelihoods for each in-sample observation;
  21. pAIC - point AIC, based on pointLik
  22. print;
  23. sigma;
  24. simulate;
  25. summary;

Future works:

  1. nus - Non-uniform Smoothing. The estimation method used in order to update parameters of regression models.
  2. sofa - Survival of the fittest algorithm applied to state space models.

Installation

The stable version of the package is available on CRAN, so you can install it by running:

install.packages("smooth")

A recent, development version, is available via github and can be installed using "remotes" in R. First, make sure that you have remotes:

if (!require("remotes")){install.packages("remotes")}

and after that run:

remotes::install_github("config-i1/smooth")

Notes

The package depends on Rcpp and RcppArmadillo, which will be installed automatically.

However Mac OS users may need to install gfortran libraries in order to use Rcpp. Follow the link for the instructions: http://www.thecoatlessprofessor.com/programming/rcpp-rcpparmadillo-and-os-x-mavericks-lgfortran-and-lquadmath-error/

Sometimes after upgrade of smooth from previous versions some functions stop working. This is because C++ functions are occasionally stored in deeper unknown corners of R's mind. Restarting R usually solves the problem. If it doesn't, completely remove smooth (uninstal + delete the folder "smooth" from R packages folder), restart R and reinstall smooth.

Owner

  • Name: Ivan Svetunkov
  • Login: config-i1
  • Kind: user
  • Location: Lancaster
  • Company: Lancaster University

GitHub Events

Total
  • Issues event: 8
  • Watch event: 6
  • Delete event: 3
  • Issue comment event: 7
  • Push event: 174
  • Pull request review event: 1
  • Pull request event: 56
  • Fork event: 3
  • Create event: 3
Last Year
  • Issues event: 8
  • Watch event: 6
  • Delete event: 3
  • Issue comment event: 7
  • Push event: 174
  • Pull request review event: 1
  • Pull request event: 56
  • Fork event: 3
  • Create event: 3

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 2,292
  • Total Committers: 7
  • Avg Commits per committer: 327.429
  • Development Distribution Score (DDS): 0.285
Past Year
  • Commits: 81
  • Committers: 2
  • Avg Commits per committer: 40.5
  • Development Distribution Score (DDS): 0.012
Top Committers
Name Email Commits
Ivan Svetunkov i****n@s****u 1,638
config-i1 i****v@g****m 496
Ivan Svetunkov i****v@l****k 118
i1 from Mac a****9@m****u 31
Svetunkov s****o@l****l 6
Ruslan Kabalin r****n@g****m 2
Dirk Eddelbuettel e****d@d****g 1
Committer Domains (Top 20 + Academic)
debian.org: 1 mail.ru: 1 lancaster.ac.uk: 1 svetunkov.ru: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 97
  • Total pull requests: 91
  • Average time to close issues: about 1 year
  • Average time to close pull requests: 7 days
  • Total issue authors: 22
  • Total pull request authors: 6
  • Average comments per issue: 2.43
  • Average comments per pull request: 0.22
  • Merged pull requests: 84
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 5
  • Pull requests: 58
  • Average time to close issues: about 11 hours
  • Average time to close pull requests: 1 day
  • Issue authors: 5
  • Pull request authors: 3
  • Average comments per issue: 0.4
  • Average comments per pull request: 0.05
  • Merged pull requests: 53
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • config-i1 (60)
  • Steviey (15)
  • T-Flet (3)
  • stelsemeyer (1)
  • bastistician (1)
  • m-muecke (1)
  • ltsaprounis (1)
  • alsabtay (1)
  • sbcalaff (1)
  • mbanco (1)
  • pogigroo (1)
  • SkyStreet (1)
  • mamut86 (1)
  • AnscombesGimlet (1)
  • ArthurAndrews (1)
Pull Request Authors
  • config-i1 (74)
  • ltsaprounis (13)
  • FilTheo (13)
  • kabalin (2)
  • MonikaZimmermann (2)
  • eddelbuettel (1)
Top Labels
Issue Labels
enhancement (38) bug (20) ADAM (14) mañana (11) idea (9) Multivariate models (7) question (4) fix (3) highest priority (3) help wanted (2) documentation (1) duplicate (1)
Pull Request Labels
ADAM (1)

Packages

  • Total packages: 2
  • Total downloads:
    • cran 4,675 last-month
  • Total docker downloads: 44,471
  • Total dependent packages: 6
    (may contain duplicates)
  • Total dependent repositories: 13
    (may contain duplicates)
  • Total versions: 81
  • Total maintainers: 1
proxy.golang.org: github.com/config-i1/smooth
  • Versions: 27
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 6.4%
Average: 6.6%
Dependent repos count: 6.8%
Last synced: 6 months ago
cran.r-project.org: smooth

Forecasting Using State Space Models

  • Versions: 54
  • Dependent Packages: 6
  • Dependent Repositories: 13
  • Downloads: 4,675 Last month
  • Docker Downloads: 44,471
Rankings
Downloads: 4.1%
Stargazers count: 4.4%
Forks count: 5.1%
Dependent repos count: 8.0%
Dependent packages count: 8.2%
Average: 9.1%
Docker downloads count: 24.9%
Maintainers (1)
ivan@svetunkov.com
Last synced: 6 months ago

Dependencies

DESCRIPTION cran
  • R >= 3.0.2 depends
  • greybox >= 1.0.5 depends
  • MASS * imports
  • Rcpp >= 0.12.3 imports
  • generics >= 0.1.2 imports
  • grDevices * imports
  • graphics * imports
  • nloptr * imports
  • pracma * imports
  • statmod * imports
  • stats * imports
  • utils * imports
  • zoo * imports
  • doMC * suggests
  • doParallel * suggests
  • foreach * suggests
  • knitr * suggests
  • legion * suggests
  • numDeriv * suggests
  • rmarkdown * suggests
  • testthat * suggests
.github/workflows/test.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/upload-artifact main composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite