Skip to content

Commit

Permalink
add readme stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
tanho63 committed Mar 6, 2022
1 parent ba55967 commit 2d92bc7
Show file tree
Hide file tree
Showing 4 changed files with 155 additions and 51 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
^LICENSE\.md$
^.*\.Rproj$
^\.Rproj\.user$
^README\.Rmd$
123 changes: 123 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```

# nflverse-data

<!-- badges: start -->
<!-- badges: end -->

This repository holds automated data releases for nflverse projects (i.e. all of the data powered/scraped via GitHub Actions).

## Usage

You can download data hosted here with the `{nflreadr}` package, or manually download and access the [releases](https://github.com/nflverse/nflverse-data/releases) page. Releases are roughly organized along the [main functions](https://nflreadr.nflverse.com/reference/) of nflreadr.

## Automation Status

The following table reports on the status and last update times of nflverse data pipelines.

```{r echo = FALSE, message = FALSE, warning = FALSE}
# piggyback::pb_list() |>
# dplyr::filter(file_name %in% c("timestamp.json","")) |>
# dplyr::distinct(tag,file_name) |>
# saveRDS("man/data_releases.rds")
update_times <- readRDS("man/data_releases.rds") |>
dplyr::mutate(url = glue::glue("https://github.com/nflverse/nflverse-data/releases/download/{tag}/timestamp.json"),
badge = glue::glue("![{tag}](https://img.shields.io/badge/dynamic/json?color=blue&label={paste0('load_',tag)}&query=last_updated&style=flat-square&url={URLencode(url)})")) |>
dplyr::select(
Data = tag,
`Last Updated` = badge
) |>
dplyr::bind_rows(
list(Data = "pbp_raw", `Last Updated` = "![raw pbp data](https://img.shields.io/github/last-commit/nflverse/nflfastR-raw?label=Raw%20PBP%20Updated&style=flat-square)")
)
status <- tibble::tribble(
~Data, ~ Status,
"pbp_raw", "",
"pbp", "![pbp and ps](https://img.shields.io/github/workflow/status/nflverse/nflfastR-data/update_current_season_pbp_and_stats?label=pbp_status&style=flat-square)",
"player_stats", "![pbp and ps](https://img.shields.io/github/workflow/status/nflverse/nflfastR-data/update_current_season_pbp_and_stats?label=ps_status&style=flat-square)",
"rosters", "![rosters](https://img.shields.io/github/workflow/status/nflverse/nflfastR-roster/update_rosters?label=rosters_status&style=flat-square)",
"snap_counts", "![snap_counts](https://img.shields.io/github/workflow/status/nflverse/pfr_scrapR/update_snap_counts?label=snaps_status&style=flat-square)",
"pfr_advstats", "![adv_stats](https://img.shields.io/github/workflow/status/nflverse/pfr_scrapR/update_adv_stats?label=advstats_status&style=flat-square)",
"nextgen_stats", "![ngs](https://img.shields.io/github/workflow/status/nflverse/ngs-data/update_ngs?label=ngs_status&style=flat-square)",
"injuries", "",
"depth_charts", "",
"combine", "",
"nfl4th", "![nfl4th](https://img.shields.io/github/workflow/status/nflverse/nfl4th/update-computed-numbers?label=nfl4th_precompute&style=flat-square)",
"ffverse player IDs", "![weekly-playerids](https://img.shields.io/github/workflow/status/dynastyprocess/data/weekly-playerids?label=ff_playerids&style=flat-square)",
"ffverse rankings", "![weekly-fantasypros](https://img.shields.io/github/workflow/status/dynastyprocess/data/weekly-fantasypros?label=rankings&style=flat-square)"
) |>
dplyr::left_join(update_times, by = "Data") |>
dplyr::mutate_all(tidyr::replace_na,"")
```

```{r echo = FALSE, message = FALSE, warning = FALSE}
knitr::kable(status)
```

```{asis include = FALSE}
### Play by Play
![raw](https://img.shields.io/github/last-commit/nflverse/nflfastR-raw?label=Raw%20PBP%20Updated&style=flat-square)
Raw JSON should appear 1-2 hours after each game.
![pbp and ps](https://img.shields.io/github/workflow/status/nflverse/nflfastR-data/update_current_season_pbp_and_stats?label=PBP%20%26%20Player%20Stats&style=flat-square)
PBP and PS are updated at 9:00 UTC each day from September to February
### Rosters
![rosters](https://img.shields.io/github/workflow/status/nflverse/nflfastR-roster/update_rosters?label=Rosters&style=flat-square)
Rosters are updated at 7:00 UTC each day.
### Snap Counts
![snap_counts](https://img.shields.io/github/workflow/status/nflverse/pfr_scrapR/update_snap_counts?label=Snap%20Counts&style=flat-square)
Snap counts are polled four times a day for new data.
### Advanced Pass/Rush/Rec/Def Stats
![adv_stats](https://img.shields.io/github/workflow/status/nflverse/pfr_scrapR/update_adv_stats?label=PFR%20Adv%20Stats&style=flat-square)
Advanced Stats are polled four times a day for new data.
### Next Gen Stats
![ngs](https://img.shields.io/github/workflow/status/nflverse/ngs-data/update_ngs?label=NGS%20data&style=flat-square)
NGS is polled every day at 7:00 UTC from September to February.
### nfl4th
![nfl4th](https://img.shields.io/github/workflow/status/nflverse/nfl4th/update-computed-numbers?label=nfl4th_precompute&style=flat-square)
nfl4th's precomputed numbers are rebuilt each day at 7:00 UTC from September to February.
### ffverse player IDs
![weekly-playerids](https://img.shields.io/github/workflow/status/dynastyprocess/data/weekly-playerids?label=ff_playerids&style=flat-square)
This is updated on a weekly basis.
### ffverse rankings
![weekly-fantasypros](https://img.shields.io/github/workflow/status/dynastyprocess/data/weekly-fantasypros?label=rankings&style=flat-square)
This is updated on Thursdays at 7:00 pm ET.
```

82 changes: 31 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,39 @@
# nflverse-data

This repository holds automated data releases for nflverse projects.

## Usage

You can download data hosted here with the `{nflreadr}` package, or manually download and access the [releases](https://github.com/nflverse/nflverse-data/releases) page. Releases are roughly organized along the [main functions](https://nflreadr.nflverse.com/reference/) of nflreadr.

## Automation Status

This page reports the schedule and status of nflverse data pipelines.

### Play by Play

![raw](https://img.shields.io/github/last-commit/nflverse/nflfastR-raw?label=Raw%20PBP%20Updated&style=flat-square)

Raw JSON should appear 1-2 hours after each game.

![pbp and ps](https://img.shields.io/github/workflow/status/nflverse/nflfastR-data/update_current_season_pbp_and_stats?label=PBP%20%26%20Player%20Stats&style=flat-square)

PBP and PS are updated at 9:00 UTC each day from September to February

### Rosters
![rosters](https://img.shields.io/github/workflow/status/nflverse/nflfastR-roster/update_rosters?label=Rosters&style=flat-square)
<!-- README.md is generated from README.Rmd. Please edit that file -->

Rosters are updated at 7:00 UTC each day.

### Snap Counts
![snap_counts](https://img.shields.io/github/workflow/status/nflverse/pfr_scrapR/update_snap_counts?label=Snap%20Counts&style=flat-square)

Snap counts are polled four times a day for new data.

### Advanced Pass/Rush/Rec/Def Stats

![adv_stats](https://img.shields.io/github/workflow/status/nflverse/pfr_scrapR/update_adv_stats?label=PFR%20Adv%20Stats&style=flat-square)

Advanced Stats are polled four times a day for new data.

### Next Gen Stats

![ngs](https://img.shields.io/github/workflow/status/nflverse/ngs-data/update_ngs?label=NGS%20data&style=flat-square)

NGS is polled every day at 7:00 UTC from September to February.

### nfl4th
# nflverse-data

![nfl4th](https://img.shields.io/github/workflow/status/nflverse/nfl4th/update-computed-numbers?label=nfl4th_precompute&style=flat-square)
<!-- badges: start -->
<!-- badges: end -->

nfl4th's precomputed numbers are rebuilt each day at 7:00 UTC from September to February.
This repository holds automated data releases for nflverse projects
(i.e. all of the data powered/scraped via GitHub Actions).

### ffverse player IDs
![weekly-playerids](https://img.shields.io/github/workflow/status/dynastyprocess/data/weekly-playerids?label=ff_playerids&style=flat-square)
## Usage

This is updated on a weekly basis.
You can download data hosted here with the `{nflreadr}` package, or
manually download and access the
[releases](https://github.com/nflverse/nflverse-data/releases) page.
Releases are roughly organized along the [main
functions](https://nflreadr.nflverse.com/reference/) of nflreadr.

### ffverse rankings
![weekly-fantasypros](https://img.shields.io/github/workflow/status/dynastyprocess/data/weekly-fantasypros?label=rankings&style=flat-square)
## Automation Status

This is updated on Thursdays at 7:00 pm ET.
The following table reports on the status and last update times of
nflverse data pipelines.

| Data | Status | Last Updated |
|:-------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| pbp\_raw | | ![raw pbp data](https://img.shields.io/github/last-commit/nflverse/nflfastR-raw?label=Raw%20PBP%20Updated&style=flat-square) |
| pbp | ![pbp and ps](https://img.shields.io/github/workflow/status/nflverse/nflfastR-data/update_current_season_pbp_and_stats?label=pbp_status&style=flat-square) | ![pbp](https://img.shields.io/badge/dynamic/json?color=blue&label=load_pbp&query=last_updated&style=flat-square&url=https://github.com/nflverse/nflverse-data/releases/download/pbp/timestamp.json) |
| player\_stats | ![pbp and ps](https://img.shields.io/github/workflow/status/nflverse/nflfastR-data/update_current_season_pbp_and_stats?label=ps_status&style=flat-square) | ![player\_stats](https://img.shields.io/badge/dynamic/json?color=blue&label=load_player_stats&query=last_updated&style=flat-square&url=https://github.com/nflverse/nflverse-data/releases/download/player_stats/timestamp.json) |
| rosters | ![rosters](https://img.shields.io/github/workflow/status/nflverse/nflfastR-roster/update_rosters?label=rosters_status&style=flat-square) | ![rosters](https://img.shields.io/badge/dynamic/json?color=blue&label=load_rosters&query=last_updated&style=flat-square&url=https://github.com/nflverse/nflverse-data/releases/download/rosters/timestamp.json) |
| snap\_counts | ![snap\_counts](https://img.shields.io/github/workflow/status/nflverse/pfr_scrapR/update_snap_counts?label=snaps_status&style=flat-square) | ![snap\_counts](https://img.shields.io/badge/dynamic/json?color=blue&label=load_snap_counts&query=last_updated&style=flat-square&url=https://github.com/nflverse/nflverse-data/releases/download/snap_counts/timestamp.json) |
| pfr\_advstats | ![adv\_stats](https://img.shields.io/github/workflow/status/nflverse/pfr_scrapR/update_adv_stats?label=advstats_status&style=flat-square) | ![pfr\_advstats](https://img.shields.io/badge/dynamic/json?color=blue&label=load_pfr_advstats&query=last_updated&style=flat-square&url=https://github.com/nflverse/nflverse-data/releases/download/pfr_advstats/timestamp.json) |
| nextgen\_stats | ![ngs](https://img.shields.io/github/workflow/status/nflverse/ngs-data/update_ngs?label=ngs_status&style=flat-square) | ![nextgen\_stats](https://img.shields.io/badge/dynamic/json?color=blue&label=load_nextgen_stats&query=last_updated&style=flat-square&url=https://github.com/nflverse/nflverse-data/releases/download/nextgen_stats/timestamp.json) |
| injuries | | ![injuries](https://img.shields.io/badge/dynamic/json?color=blue&label=load_injuries&query=last_updated&style=flat-square&url=https://github.com/nflverse/nflverse-data/releases/download/injuries/timestamp.json) |
| depth\_charts | | ![depth\_charts](https://img.shields.io/badge/dynamic/json?color=blue&label=load_depth_charts&query=last_updated&style=flat-square&url=https://github.com/nflverse/nflverse-data/releases/download/depth_charts/timestamp.json) |
| combine | | ![combine](https://img.shields.io/badge/dynamic/json?color=blue&label=load_combine&query=last_updated&style=flat-square&url=https://github.com/nflverse/nflverse-data/releases/download/combine/timestamp.json) |
| nfl4th | ![nfl4th](https://img.shields.io/github/workflow/status/nflverse/nfl4th/update-computed-numbers?label=nfl4th_precompute&style=flat-square) | |
| ffverse player IDs | ![weekly-playerids](https://img.shields.io/github/workflow/status/dynastyprocess/data/weekly-playerids?label=ff_playerids&style=flat-square) | |
| ffverse rankings | ![weekly-fantasypros](https://img.shields.io/github/workflow/status/dynastyprocess/data/weekly-fantasypros?label=rankings&style=flat-square) | |
Binary file added man/data_releases.rds
Binary file not shown.

0 comments on commit 2d92bc7

Please sign in to comment.