This package contains functions for working with the Zoltar forecast repository’s API, including projects, models, forecasts, and scores. Read more about this package at the zoltr pkgdown site. Documentation on Zolar itself is at docs.zoltardata.com.
You can install the released version of zoltr from CRAN with:
install.packages("zoltr")
And the development version from GitHub with:
# install.packages("devtools")
::install_github("reichlab/zoltr") devtools
Read more at the zoltr pkgdown
site, but briefly you use the new_connection()
function
to create a connection to Zoltar and then pass that
connection along with the URL of the resource of interest
(e.g., a project, model, or forecast) to this package’s various
functions like projects()
, project_info()
, or
scores()
.
library(zoltr)
<- new_connection()
zoltar_connection zoltar_authenticate(zoltar_connection, Sys.getenv("Z_USERNAME"), Sys.getenv("Z_PASSWORD"))
zoltar_connection#> ZoltarConnection 'https://zoltardata.com' authenticated (exp=2020-04-09 18:00:13 UTC)
<- projects(zoltar_connection)
the_projects <- the_projects[the_projects$name == "Docs Example Project", "url"]
project_url <- project_info(zoltar_connection, project_url)
the_project_info names(the_project_info)
#> [1] "id" "url" "owner"
#> [4] "is_public" "name" "description"
#> [7] "home_url" "logo_url" "core_data"
#> [10] "time_interval_type" "visualization_y_label" "truth"
#> [13] "model_owners" "score_data" "models"
#> [16] "units" "targets" "timezeros"
$name
the_project_info#> [1] "Docs Example Project"
The native forecast data format supported by the Zoltar API is a
list
. See docs.zoltardata.com for format
details. You can find an example at vignettes/docs-predictions.json . By
convention this package referred to this as forecast_data
.
This package supports conversion to this format (which is used
throughout the package) from the CDC’s CSV file format [1] via the
forecast_data_from_cdc_csv_file
() function. Future versions
will support bidirectional conversion, as well as support for a more
general CSV format.
[1] Details about the CDC CSV format can be found at flu_challenge_2016-17_update.docx.