zoltr v0.2.2

0

Monthly downloads

0th

Percentile

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 information about projects, models, and forecasts, deleting and uploading forecast data, and downloading scores.

Readme

zoltr - An R client for the Zoltar data repository API

Overview

This package contains functions for working with the Zoltar forecast repository's API, including projects, models, forecasts, and scores. Read more at the zoltr pkgdown site.

Installation

You can install the released version of zoltr from CRAN with:

install.packages("zoltr")

And the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("reichlab/zoltr")

Usage

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 ID 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)
conn <- new_connection()
conn
#> ZoltarConnection 'https://zoltardata.com' not authenticated

the_projects <- projects(conn)
project_id <- the_projects[1,]$id
the_project_info <- project_info(conn, project_id)
names(the_project_info)
#>  [1] "id"           "url"          "owner"        "is_public"   
#>  [5] "name"         "description"  "home_url"     "core_data"   
#>  [9] "config_dict"  "template"     "truth"        "model_owners"
#> [13] "score_data"   "models"       "locations"    "targets"     
#> [17] "timezeros"
the_project_info$name
#> [1] "CDC Flu challenge"

Functions in zoltr

Name Description
delete_forecast Delete a forecast
forecast_info Gets a forecast's information
forecasts Get a model's forecasts
forecast_data Gets a forecast's data
project_info Get information about a project
new_connection Get a connection to a Zoltar host
model_info Get information about a model
upload_forecast Upload a forecast
models Get a project's models
zoltar_authenticate Log in to a Zoltar host
zoltr-package zoltr: Interface to the 'Zoltar' Forecast Repository API
upload_info Get an upload's information
projects Get information about all projects
scores Get a project's scores
No Results!

Vignettes of zoltr

Name
getting-started.Rmd
project-owners.Rmd
No Results!

Last month downloads

Details

URL https://github.com/reichlab/zoltr , http://reichlab.io/zoltr/
BugReports https://github.com/reichlab/zoltr/issues
License GPL-3
Encoding UTF-8
LazyData true
RoxygenNote 6.1.1
VignetteBuilder knitr
NeedsCompilation no
Packaged 2019-05-30 18:35:05 UTC; cornell
Repository CRAN
Date/Publication 2019-05-30 18:50:03 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/zoltr)](http://www.rdocumentation.org/packages/zoltr)