Skip to content

Commit 71cd137

Browse files
sbfnkclaude
andcommitted
Improve documentation readability and add related packages
- Add explicit library(scoringutils) call in README example - Change model names from bold to italic throughout documentation - Remove excessive bold formatting from features, prerequisites, and section headers - Add Related Packages section acknowledging fable, forecast, prophet, and modeltime This reduces visual clutter and improves accessibility while maintaining clear structure. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 8a0b607 commit 71cd137

File tree

4 files changed

+187
-176
lines changed

4 files changed

+187
-176
lines changed

README.Rmd

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,18 @@ An R package providing access to 10 baseline forecasting models from the Julia F
2626

2727
## Features
2828

29-
- **10 Forecasting Models**: From simple baselines (Constant, Marginal) to advanced time series models (ARMA, ETS, STL)
30-
- **Probabilistic Forecasting**: Multiple methods for prediction intervals (empirical, parametric, model-based)
31-
- **Comprehensive Scoring**: Compatible with scoringutils for all standard forecast evaluation metrics
32-
- **Data Transformations**: Log, power, Box-Cox transformations with automatic back-transformation
29+
- 10 Forecasting Models: From simple baselines (Constant, Marginal) to advanced time series models (ARMA, ETS, STL)
30+
- Probabilistic Forecasting: Multiple methods for prediction intervals (empirical, parametric, model-based)
31+
- Comprehensive Scoring: Compatible with scoringutils for all standard forecast evaluation metrics
32+
- Data Transformations: Log, power, Box-Cox transformations with automatic back-transformation
3333

3434
## Installation
3535

3636
### Prerequisites
3737

38-
1. **Julia** (>= 1.9): Download from [julialang.org](https://julialang.org/downloads/)
39-
2. **R** (>= 3.5.0)
40-
3. **JuliaCall R package**: `install.packages("JuliaCall")`
38+
1. Julia (>= 1.9): Download from [julialang.org](https://julialang.org/downloads/)
39+
2. R (>= 3.5.0)
40+
3. JuliaCall R package: `install.packages("JuliaCall")`
4141

4242
### Installing forecastbaselines
4343

@@ -62,6 +62,8 @@ This only needs to be done once per R session.
6262
## Quick Example
6363

6464
```{r example}
65+
library(scoringutils) # for scoring
66+
6567
# Your time series data
6668
data <- c(1.2, 2.3, 3.1, 2.8, 3.5, 4.2, 3.9, 4.5, 4.1, 4.8)
6769
@@ -93,20 +95,20 @@ scores_summary[, c("model", "ae_point", "se_point")]
9395
## Available Models
9496

9597
### Simple Baseline Models
96-
- **ConstantModel**: Naive forecast using last observed value
97-
- **MarginalModel**: Forecasts based on empirical marginal distribution
98-
- **KDEModel**: Kernel density estimation
98+
- *ConstantModel*: Naive forecast using last observed value
99+
- *MarginalModel*: Forecasts based on empirical marginal distribution
100+
- *KDEModel*: Kernel density estimation
99101

100102
### Seasonal/Trend Models
101-
- **LSDModel**: Last Similar Dates method (seasonal patterns)
102-
- **OLSModel**: Ordinary least squares with polynomial trends
103-
- **IDSModel**: Increase-Decrease-Stable trend detection
104-
- **STLModel**: Seasonal-Trend decomposition using Loess
103+
- *LSDModel*: Last Similar Dates method (seasonal patterns)
104+
- *OLSModel*: Ordinary least squares with polynomial trends
105+
- *IDSModel*: Increase-Decrease-Stable trend detection
106+
- *STLModel*: Seasonal-Trend decomposition using Loess
105107

106108
### Advanced Time Series Models
107-
- **ARMAModel**: Autoregressive Moving Average
108-
- **INARCHModel**: Integer-valued ARCH for count data
109-
- **ETSModel**: Error-Trend-Season exponential smoothing (all 30 variants)
109+
- *ARMAModel*: Autoregressive Moving Average
110+
- *INARCHModel*: Integer-valued ARCH for count data
111+
- *ETSModel*: Error-Trend-Season exponential smoothing (all 30 variants)
110112

111113
## Documentation
112114

@@ -116,11 +118,20 @@ For detailed guides and examples:
116118
- `vignette("forecast-models")` - Detailed guide to all 10 models
117119
- `vignette("transformations")` - Working with data transformations
118120

121+
## Related Packages
122+
123+
For comprehensive time series forecasting in R, consider:
124+
125+
- [fable](https://fable.tidyverts.org/) - A complete forecasting framework in the [tidyverts](https://tidyverts.org/) ecosystem
126+
- [forecast](https://pkg.robjhyndman.com/forecast/) - The classic R forecasting package with auto.arima, ets, and many other methods
127+
- [prophet](https://facebook.github.io/prophet/) - Facebook's forecasting package for time series with strong seasonal patterns
128+
- [modeltime](https://business-science.github.io/modeltime/) - A tidymodels framework for time series forecasting
129+
119130
## Citation
120131

121132
If you use this package in your research, please cite the software and the associated preprint:
122133

123-
**Software:**
134+
Software:
124135
```
125136
@software{forecastbaselinesr,
126137
title = {forecastbaselines: R Interface to ForecastBaselines.jl},
@@ -130,7 +141,7 @@ If you use this package in your research, please cite the software and the assoc
130141
}
131142
```
132143

133-
**Preprint:**
144+
Preprint:
134145
```
135146
@article{stapper2025baseline,
136147
title = {Mind the Baseline: The Hidden Impact of Reference Model Selection on Forecast Assessment},

0 commit comments

Comments
 (0)