Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create README.md #36

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Create README.md #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## EuroForecastHub package

Functions to support the European COVID-19 [Forecast](https://github.com/covid19-forecast-hub-europe/covid19-forecast-hub-europe) and [Scenario](https://github.com/covid19-forecast-hub-europe/covid19-scenario-hub-europe) Hubs. For similar functionality, see [covidHubUtils](https://github.com/reichlab/covidHubUtils).

Install the package with:

```
remotes::install_github("covid19-forecast-hub-europe/EuroForecastHub")
```

### Functionality

Use `devtools::build_manual()` to see complete function documentation.

Hub metadata
- `get_hub_config()`
- `get_model_designations()`
- `link_preview()`

Observed data handling
- `add_status()`
- `date_to_week_end()`
- `convert_to_weekly()`

Creating ensembles
- `weighted_average()`
- `create_ensemble_average()`
- `create_ensemble_relative_skill()`
- `use_ensemble_criteria()`
- `add_point_forecasts()`
- `format_ensemble()`
- `run_ensemble()`
- `run_multiple_ensembles()`

Forecast scoring
- `score_forecasts()`
- `summarise_scores()`