Data

Tools

Indexes

Applications

Experiments

Open Source Science

zoltr

https://github.com/reichlab/zoltr

Science Score: 23.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    3 of 7 committers (42.9%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (17.0%) to scientific vocabulary

Keywords from Contributors

trait
Last synced: 11 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: reichlab
  • License: gpl-3.0
  • Language: R
  • Default Branch: master
  • Homepage: http://reichlab.io/zoltr/
  • Size: 1.01 MB
Statistics
  • Stars: 2
  • Watchers: 3
  • Forks: 3
  • Open Issues: 11
  • Releases: 4
Created over 7 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog License

README.Rmd 

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  message=FALSE,
  warning=FALSE,
  eval = nzchar(Sys.getenv("IS_DEVELOPMENT_MACHINE"))
)
```


# zoltr - An R client for the Zoltar data repository API

## Overview

This package contains functions for working with the [Zoltar](https://www.zoltardata.com/) forecast repository's API, including projects, models, forecasts, and truth. Read more about this package at the [zoltr pkgdown site](http://reichlab.io/zoltr/). Documentation on Zolar itself is at [docs.zoltardata.com](https://docs.zoltardata.com/).


## Installation

You can install the released version of zoltr from [CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("zoltr")
```

And the development version from [GitHub](https://github.com/) with:

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

> Note: Due to the rapid pace of zoltr development, CRAN version lags behind development. We highly suggest you install the development version to get the latest features.  


## Getting started

For those starting out we recommend you begin with the "Getting Started" vignette.


## Usage

Read more at the [zoltr pkgdown site](http://reichlab.io/zoltr/), but briefly you use the `new_connection()` function to create a connection to [Zoltar](https://www.zoltardata.com/) 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()` or `project_info()`.

```{r}
library(zoltr)
zoltar_connection <- new_connection()
zoltar_authenticate(zoltar_connection, Sys.getenv("Z_USERNAME"), Sys.getenv("Z_PASSWORD"))
zoltar_connection

the_projects <- projects(zoltar_connection)
project_url <- the_projects[the_projects$name == "Docs Example Project", "url"]
the_project_info <- project_info(zoltar_connection, project_url)
names(the_project_info)
the_project_info$name
```


## Forecast data format

The native forecast data format supported by the Zoltar API is a `list`. See [docs.zoltardata.com](https://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 were formerly found in a Word document ("flu_challenge_2016-17_update.docx") that's since been deleted. From that document's "Objectives" section:

> For each week during the season, participants will be asked to provide national and regional probabilistic forecasts for the entire influenza season (seasonal targets) and for the next four weeks (four-week ahead targets). The seasonal targets are the onset week, the peak week, and the peak intensity of the 2016-2017 influenza season. The four-week ahead targets are the percent of outpatient visits experiencing influenza-like illness (ILI) one week, two weeks, three weeks, and four weeks ahead from date of the forecast.

Owner

  • Name: The Reich Lab at UMass-Amherst
  • Login: reichlab
  • Kind: organization
  • Location: Amherst, MA

GitHub Events

Total
  • Create event: 3
  • Release event: 1
  • Issues event: 3
  • Delete event: 2
  • Issue comment event: 1
  • Member event: 1
  • Push event: 3
  • Pull request review event: 7
  • Pull request review comment event: 9
  • Pull request event: 3
Last Year
  • Create event: 3
  • Release event: 1
  • Issues event: 3
  • Delete event: 2
  • Issue comment event: 1
  • Member event: 1
  • Push event: 3
  • Pull request review event: 7
  • Pull request review comment event: 9
  • Pull request event: 3

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 192
  • Total Committers: 7
  • Avg Commits per committer: 27.429
  • Development Distribution Score (DDS): 0.073
Past Year
  • Commits: 12
  • Committers: 2
  • Avg Commits per committer: 6.0
  • Development Distribution Score (DDS): 0.083
Top Committers
Name Email Commits
matthewcornell m****t@m****g 178
Hugo Gruson h****n@p****m 7
Serena-Wang w****y@m****u 2
Hugo Gruson B****o 2
Nicholas G Reich n****k@u****u 1
Evan Ray e****1 1
Evan Ray e****y@m****u 1
Committer Domains (Top 20 + Academic)
mtholyoke.edu: 2 umass.edu: 1 matthewcornell.org: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 3
  • Total pull requests: 1
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 28 minutes
  • Total issue authors: 2
  • Total pull request authors: 1
  • Average comments per issue: 0.33
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 1
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 28 minutes
  • Issue authors: 2
  • Pull request authors: 1
  • Average comments per issue: 0.33
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • matthewcornell (2)
  • hadley (1)
Pull Request Authors
  • matthewcornell (2)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 404 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 6
  • Total maintainers: 1
cran.r-project.org: zoltr

Interface to the 'Zoltar' Forecast Repository API

  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 404 Last month
Rankings
Forks count: 12.2%
Dependent repos count: 23.9%
Stargazers count: 27.8%
Dependent packages count: 28.7%
Average: 33.2%
Downloads: 73.7%
Maintainers (1)
cornell@umass.edu
Last synced: 11 months ago

Dependencies

DESCRIPTION cran
  • MMWRweek * imports
  • base64url * imports
  • data.table * imports
  • dplyr * imports
  • httr * imports
  • jsonlite * imports
  • lubridate * imports
  • magrittr * imports
  • readr * imports
  • rlang * imports
  • utils * imports
  • knitr * suggests
  • mockery * suggests
  • rmarkdown * suggests
  • testthat * suggests
  • webmockr * suggests
.github/workflows/check-standard.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite