Package: zoltr 1.0.2

Matthew Cornell

zoltr: Interface to the 'Zoltar' Forecast Repository API

'Zoltar' <https://www.zoltardata.com/> is a website that provides a repository of model forecast results in a standardized format and a central location. It supports storing, retrieving, comparing, and analyzing time series forecasts for prediction challenges of interest to the modeling community. This package provides functions for working with the 'Zoltar' API, including connecting and authenticating, getting meta information (projects, models, and forecasts, and truth), and uploading, downloading, and deleting forecast and truth data.

Authors:Matthew Cornell [aut, cre], Nicholas Reich [aut, cph]

zoltr_1.0.2.tar.gz
zoltr_1.0.2.zip(r-4.7)zoltr_1.0.2.zip(r-4.6)zoltr_1.0.2.zip(r-4.5)
zoltr_1.0.2.tgz(r-4.6-any)zoltr_1.0.2.tgz(r-4.5-any)
zoltr_1.0.2.tar.gz(r-4.7-any)zoltr_1.0.2.tar.gz(r-4.6-any)
zoltr_1.0.2.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
zoltr/json (API)

# Install 'zoltr' in R:
install.packages('zoltr', repos = c('https://reichlab.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/reichlab/zoltr/issues

Pkgdown/docs site:https://reichlab.io

On CRAN:

Conda:

7.30 score 2 stars 4 packages 209 scripts 437 downloads 1 mentions 36 exports 39 dependencies

Last updated from:e7e2587b4a. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK144
source / vignettesOK199
linux-release-x86_64OK137
macos-release-arm64OK159
macos-oldrel-arm64OK176
windows-develOK92
windows-releaseOK80
windows-oldrelOK99
wasm-releaseOK303

Exports:%>%busy_poll_jobcreate_modelcreate_projectcreate_timezerodata_frame_from_forecast_datadelete_forecastdelete_modeldelete_projectdo_zoltar_querydownload_forecastedit_modelforecast_data_from_cdc_csv_fileforecast_infoforecastsjob_datajob_infojob_info_forecast_urllatest_forecastsmodel_infomodelsnew_connectionproject_infoprojectsquantile_data_frame_from_forecast_datasubmit_querytarget_infotargetstimezero_infotimezerostruth_infounit_infoupload_forecastupload_truthzoltar_authenticatezoltar_units

Dependencies:askpassbackportsbase64urlbitbit64clicliprcpp11crayoncurldata.tabledplyrgenericsgluehmshttrjsonlitelifecyclelubridatemagrittrmimeMMWRweekopensslpillarpkgconfigprettyunitsprogressR6readrrlangsystibbletidyselecttimechangetzdbutf8vctrsvroomwithr

Getting Started
Getting Started with zoltr | Setting up your account | Connect to the host and authenticate | Get a list of all projects on the host | Get a project to work with and list its info and models | Query a project's forecast data | Query a project's truth data | Get project's latest forecast IDs and their sources | Get a model to work with and list its info and forecasts | Finally, download the forecast's data in three formats
Rendered fromgetting-started.Rmdusingknitr::rmarkdown

Last update: 2024-04-08
Started: 2019-05-13

Project Owners
zoltr for Project Owners | Connect to the host and authenticate | Create a sandbox project to play with | Add a model to the project and then upload a forecast into it | Clean up by deleting the sandbox project
Rendered fromproject-owners.Rmdusingknitr::rmarkdown

Last update: 2024-04-08
Started: 2019-05-13

Readme and manuals

Help Manual

Help pageTopics
Poll job's statusbusy_poll_job
Create a modelcreate_model
Create a projectcreate_project
Create a timezerocreate_timezero
Converts forecast data from Zoltar's native 'list' format to a 'data.frame'data_frame_from_forecast_data
Delete a forecastdelete_forecast
Delete a modeldelete_model
Delete a projectdelete_project
A convenience function to construct and execute a Zoltar query for either forecast or truth data.do_zoltar_query
Gets a forecast's datadownload_forecast
Edit a modeledit_model
Loads and converts a CDC CSV file to Zoltar's native 'list' formatforecast_data_from_cdc_csv_file
'forecast_data_from_cdc_csv_file()' helperforecast_data_from_cdc_data_frame
Gets a forecast's informationforecast_info
Get a model's forecastsforecasts
Get JSON for a resource (URL). Authenticates if necessaryget_resource
Gets a job's file's datajob_data
Get a job's informationjob_info
Get a new forecast upload's urljob_info_forecast_url
Get a project's latest_forecastslatest_forecasts
Get information about a modelmodel_info
Get a project's modelsmodels
Get a connection to a Zoltar hostnew_connection
Get information about a projectproject_info
Get information about all projectsprojects
Converts forecast data from Zoltar's native 'list' format to a quantile 'data.frame'quantile_data_frame_from_forecast_data
Submit a querysubmit_query
Get information about a targettarget_info
Get a project's targetstargets
Get information about a timezerotimezero_info
Get a project's timezerostimezeros
Get information about a project's truthtruth_info
Get information about a unitunit_info
Upload a forecastupload_forecast
Upload truth dataupload_truth
Log in to a Zoltar hostzoltar_authenticate
Get a project's zoltar_unitszoltar_units