nflverse

Easily Install and Load the 'nflverse'

https://github.com/nflverse/nflverse

Science Score: 26.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
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (21.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Easily Install and Load the 'nflverse'

Basic Info
Statistics
  • Stars: 34
  • Watchers: 3
  • Forks: 1
  • Open Issues: 0
  • Releases: 4
Created over 5 years ago · Last pushed 12 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct

README.Rmd

---
output: github_document
---



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

# nflverse 



[![CRAN status](https://img.shields.io/cran/v/nflverse?style=flat-square&logo=R&label=CRAN)](https://CRAN.R-project.org/package=nflverse)
[![Dev status](https://img.shields.io/github/r-package/v/nflverse/nflverse/main?label=dev%20version&style=flat-square&logo=github)](https://nflverse.nflverse.com/)
[![R-CMD-check](https://img.shields.io/github/actions/workflow/status/nflverse/nflverse/R-CMD-check.yaml?label=R%20check&style=flat-square&logo=github)](https://github.com/nflverse/nflverse/actions/workflows/R-CMD-check.yaml)
[![nflverse support](https://img.shields.io/discord/789805604076126219?color=7289da&label=nflverse%20support&logo=discord&logoColor=fff&style=flat-square)](https://discord.com/invite/5Er2FBnnQa)


## Overview

The nflverse is a set of packages dedicated to data of the National Football League. The __nflverse__ package is designed to make it easy to install and load core packages from the nflverse in a single command. Please see the [nflverse organisation repo](https://github.com/nflverse/nflverse-org) on more information about governance, the code of conduct and possible roles. 

## Installation

The easiest way to get nflverse is to install it from [CRAN](https://cran.r-project.org/package=nflverse) with:

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

To get a bug fix or to use a feature from the development version, you can install the development version of nflverse either from [GitHub](https://github.com/nflverse/nflverse/) with:

```{r eval = FALSE}
if (!requireNamespace("pak")) install.packages("pak")
pak::pak("nflverse/nflverse")
```

or prebuilt from the [development repo](https://nflverse.r-universe.dev) with:

```{r eval = FALSE}
install.packages("nflverse", repos = c("https://nflverse.r-universe.dev", getOption("repos")))
```

## Usage

`library(nflverse)` will load the following nflverse packages: 

* [nflfastR](https://www.nflfastr.com/), for play-by-play data back to 1999.
* [nflseedR](https://nflseedr.com/), for season simulations.
* [nfl4th](https://www.nfl4th.com/), for 4th down analysis.
* [nflreadr](https://nflreadr.nflverse.com/), for fast end efficient nflverse data downloads.
* [nflplotR](https://nflplotr.nflverse.com/), for tools to create visualization of NFL related analysis.

## Getting help

The best places to get help on this package are:

-   the [nflverse discord](https://discord.com/invite/5Er2FBnnQa) (for both this package as well as anything R/NFL related)
-   opening [an issue](https://github.com/nflverse/nflverse/issues/new/choose)

## Contributing

Many hands make light work! Here are some ways you can contribute to
this project:

-   You can [open an issue](https://github.com/nflverse/nflverse/issues/new/choose) if you'd like to request specific data or report a bug/error.

-   If you'd like to contribute code, please check out [the contribution guidelines](https://nflverse.nflverse.com/CONTRIBUTING.html).

## Terms of Use

The R code for this package is released as open source under the [MIT License](https://nflverse.nflverse.com/LICENSE.html). NFL data accessed by this package belong to their respective owners, and are governed by their terms of use.

Owner

  • Name: nflverse
  • Login: nflverse
  • Kind: organization

nflverse is a collection of data and R packages designed for NFL analytics!

GitHub Events

Total
  • Watch event: 11
  • Delete event: 2
  • Push event: 5
  • Pull request event: 3
  • Fork event: 1
  • Create event: 1
Last Year
  • Watch event: 11
  • Delete event: 2
  • Push event: 5
  • Pull request event: 3
  • Fork event: 1
  • Create event: 1

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 55
  • Total Committers: 4
  • Avg Commits per committer: 13.75
  • Development Distribution Score (DDS): 0.109
Past Year
  • Commits: 3
  • Committers: 2
  • Avg Commits per committer: 1.5
  • Development Distribution Score (DDS): 0.333
Top Committers
Name Email Commits
mrcaseb r****e@g****m 49
mrcaseb 3****b 3
mrcaseb m****b@g****m 2
Tan Ho 3****3 1

Issues and Pull Requests

Last synced: 12 months ago

All Time
  • Total issues: 10
  • Total pull requests: 9
  • Average time to close issues: about 19 hours
  • Average time to close pull requests: 2 days
  • Total issue authors: 6
  • Total pull request authors: 2
  • Average comments per issue: 0.7
  • Average comments per pull request: 0.33
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 1
  • Average time to close issues: 5 minutes
  • Average time to close pull requests: 7 minutes
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • mrcaseb (4)
  • Jray0801 (2)
  • bachlaw (1)
  • AccidentalGuru (1)
  • xaviergenelin (1)
Pull Request Authors
  • mrcaseb (10)
  • tanho63 (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 363 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 4
  • Total maintainers: 1
cran.r-project.org: nflverse

Easily Install and Load the 'nflverse'

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 363 Last month
Rankings
Stargazers count: 11.5%
Downloads: 15.5%
Average: 21.5%
Dependent repos count: 24.0%
Forks count: 27.8%
Dependent packages count: 28.8%
Maintainers (1)
Last synced: 12 months ago

Dependencies

DESCRIPTION cran
  • cli >= 3.0.0 imports
  • crayon >= 1.4.0 imports
  • magrittr >= 2.0.0 imports
  • nfl4th >= 1.0.1 imports
  • nflfastR >= 4.3.0 imports
  • nflplotR >= 1.0.0 imports
  • nflreadr >= 1.1.2 imports
  • nflseedR >= 1.0.2 imports
  • rlang >= 0.4.10 imports
  • rstudioapi >= 0.13 imports
  • testthat >= 3.0.0 suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v2 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
.github/workflows/pkgdown.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
  • r-lib/actions/setup-r-dependencies v1 composite