Prophet Modelling Interface for 'fable'
Overview
Allows prophet models from the 'prophet' package to be used in a tidy workflow with the modelling interface of 'fabletools'. This extends 'prophet' to provide enhanced model specification and management, performance evaluation methods, and model combination tools.
Breaking changes
- R >= 4.1.0 and fabletools >= 0.5.0 are now required. Rcpp is no longer attached by this package (prophet still loads it).
tidy()now reports extra regressor estimates as coefficients on the original data scale (additive regressors in units of the response, multiplicative regressors as proportional effects), rather than prophet's internal scaled parameters. Other terms remain on the internal scale, as documented in?tidy.fbl_prophet.forecast()no longer forwards...toprophet::predictive_samples(), which doesn't accept additional arguments....is now documented as unused.
New features
- Added
generate()for prophet models (#4), simulating sample paths (trend including future changepoints, seasonality, holidays and regressors) with normally distributed or, withbootstrap = TRUE, resampled-residual observation noise. Works in-sample and out-of-sample, including with MCMC estimation and transformed responses. - Added
refit()for prophet models (#30). By default the estimated parameters are kept and the fitted values, residuals and components are recomputed for the new data;reestimate = TRUEfits the model again on the new data using the original estimation arguments. Prophet cannot be updated incrementally, so there is nostream()method. growth()now supportstype = "flat", for a constant trend without changepoints.holiday()gains acountryargument to include prophet's built-in country holidays (viaprophet::add_country_holidays()), with or without aholidaystable.tidy()now names (and orders) holiday terms from the fitted model, so country holidays and repeated holiday dates are supported.season()gains aconditionargument (a bare logical column name) for conditional seasonality (viaprophet::add_seasonality(condition.name = )). The column must also be present innew_datawhen forecasting.prophet()now documents and supports themcmc.samplesandbackendarguments (passed toprophet::prophet()) for MCMC estimation and choosing the"rstan"or"cmdstanr"Stan backend.tidy()andglance()summarise MCMC draws by their posterior means.forecast()now supportstimes = 0, which returns point forecasts (as degenerate distributions) without simulating sample paths. Thetimesargument is now documented, including its speed and memory trade-off (#26).
Show all changes in 1.0.0Hide the rest of the changes in 1.0.0
Improvements
components()now includes theholidays,extra_regressors_additiveandextra_regressors_multiplicativeterms when they are present in the model.- Fitted models no longer keep prophet's raw Stan output (
stan.fit), reducing model size (#26). - Regressors with non-syntactic names (e.g.
log(x)orI(x^2)) are now supported, usingmake.names()to name them in the model and intidy()(#32). - Documentation: added "Non-daily data" (#28), "Performance and memory" (#26) and model evaluation sections to
?prophetand the introduction vignette.
Bug fixes
- The model is now fit with
uncertainty.samples = 0(previously the argument was misspelt and ignored), so fitting no longer computes unused uncertainty samples. - Removed an unused prediction in
forecast()(#33).
From NEWS.md in the release
Install
Health
- OK13 OK2026-08-20
- ERROR12 OK, 1 ERROR2026-08-18
- OK13 OK2026-08-05
- NOTE12 OK, 1 NOTE2026-08-01
- OK13 OK2026-07-29
Show 5 earlier changesHide 5 earlier changes
- ERROR12 OK, 1 ERROR2026-07-27
- OK13 OK2026-07-22
- ERROR12 OK, 1 ERROR2026-07-18
- OK12 OK2026-04-25
- NOTE11 OK, 3 NOTE2026-03-10
Documentation
- Help pages
- 10includes a package overview page
- Examples that run
- 43%3 run in a plain check · 4 only when donttest examples are enabled (R CMD check --as-cran)
- Exported functions with examples
- 100%
- Documented parameters
- 100%
- Return-value docs
- 0%
- Help pages citing references
- 0%
Downloads
Repository
- PRs merged (all time)
- not measured
- Median days to close, 50 most recently updated closed issues
- 18
- Median days to close, 50 most recently updated closed PRs
- not measured
Stars over time
Forks over time
Releases over time
Issues over time
Commits over time
14 development-tooling and community-health practices detected across 7 families in the upstream repository
Checks run against github.com/mitchelloharawild/fable.prophet on 2026-10-11.
The R CMD check workflow runs on Linux
GitHub Pages site last deployed 2020-08-20 · The repository has a site deploy workflow
Show all practicesHide 3 practices
Dependencies
Installing fable.prophet adds 90 packages (49 with compiled code, 81 MB of source tarballs). Heaviest: BH 14 MB, stringi 11 MB, ggplot2 6.0 MB.
Code & Tests
People & History
Pick two releases to compare their code metrics.
- 1.0.0Latest
- 0.1.12026-10-03 · diff ↗
- RR 4.6.0 released · 2026-04-24
- RR 4.5.0 released · 2025-04-11
- RR 4.4.0 released · 2024-04-24
- RR 4.3.0 released · 2023-04-21
- RR 4.2.0 released · 2022-04-22
- RR 4.1.0 released · 2021-05-18
- 0.1.02020-08-20
- RR 4.0.0 released · 2020-04-24
Package metadata
- First published
- 2020-08-20
- Total releases
- 3 / 6 yrs
- License
- GPL-3 OSI
- Minimum R
- ≥ 4.1.0
- Download size
- 523 KB
Cite
Cite this package
Run in R for the authors' preferred citation:
citation("fable.prophet")This package has no citation file, so citation() returns this entry built from DESCRIPTION.
Cite the R Observatory
For a number measured here: a download total, a coverage figure, an archival date.
From data release v2026-10-18, which the citation names so these numbers can be found later. More on citing and the projects behind them.