Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R
docs
man
tests
vignettes
.Rbuildignore
.gitignore
DESCRIPTION
LICENSE.md
NAMESPACE
NEWS.md
README.Rmd
README.md
cran-comments.md
zoltr.Rproj

README.md

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"
You can’t perform that action at this time.