# 

# sportsdataverse

The [**`sportsdataverse`**](https://r.sportsdataverse.org) is a set of
sports data packages that work in harmony because they share common data
representations and API design. This package is designed to make it easy
to install and load multiple **`sportsdataverse`** packages in a single
step. Learn more about the **`sportsdataverse`** at
[sportsdataverse.org](https://sportsdataverse.org).

## Installation

Install the stable release from
[CRAN](https://CRAN.R-project.org/package=sportsdataverse):

``` r

install.packages("sportsdataverse")
```

Or install the development version from
[GitHub](https://github.com/sportsdataverse/sportsdataverse-R) with:

``` r

if (!requireNamespace('pak', quietly = TRUE)){
  install.packages('pak')
}
pak::pak("sportsdataverse/sportsdataverse-R")
```

or prebuilt from the [SportsDataverse
r-universe](https://sportsdataverse.r-universe.dev) with:

``` r

install.packages("sportsdataverse", repos = c("https://sportsdataverse.r-universe.dev", getOption("repos")))
```

## Usage

[`library(sportsdataverse)`](https://github.com/sportsdataverse/sportsdataverse-R)
will load the following packages:

- [**`baseballr`**](https://billpetti.github.io/baseballr/), for MLB and
  college baseball data.
- [**`cfbfastR`**](https://cfbfastR.sportsdataverse.org/), for college
  football data.
- [**`fastRhockey`**](https://fastRhockey.sportsdataverse.org/), for NHL
  and PWHL hockey data.
- [**`hoopR`**](https://hoopR.sportsdataverse.org/), for men’s college
  and professional basketball data.
- [**`oddsapiR`**](https://oddsapiR.sportsdataverse.org/), for
  sportsbook odds from The Odds API.
- [**`sportyR`**](https://sportyR.sportsdataverse.org/), for drawing
  regulation playing surfaces.
- [**`wehoop`**](https://wehoop.sportsdataverse.org/), for women’s
  college and professional basketball data.

Additional ecosystem packages —
[**`cfbplotR`**](https://cfbplotR.sportsdataverse.org/),
[**`cfb4th`**](https://cfb4th.sportsdataverse.org/),
[**`recruitR`**](https://recruitR.sportsdataverse.org/),
[**`softballR`**](https://github.com/sportsdataverse/softballR/), and
[**`mlbplotR`**](https://camdenk.github.io/mlbplotR/) — are available in
the SportsDataverse but are not auto-loaded by
[`library(sportsdataverse)`](https://github.com/sportsdataverse/sportsdataverse-R).

``` r

sportsdataverse::sportsdataverse_logo()
```

![SportsDataverse unicode
logo](https://raw.githubusercontent.com/sportsdataverse/sportsdataverse-R/main/data-raw/sportsdataverse-unicode-logo.png)

## Follow [**`sportsdataverse`**](https://x.com/sportsdataverse) on X and star this repo

[![X
Follow](https://img.shields.io/twitter/follow/sportsdataverse?color=blue&label=%40sportsdataverse&logo=x&style=for-the-badge)](https://x.com/sportsdataverse)

[![GitHub
stars](https://img.shields.io/github/stars/sportsdataverse/sportsdataverse-R.svg?color=eee&logo=github&style=for-the-badge&label=Star%20sportsdataverse&maxAge=2592000)](https://github.com/sportsdataverse/sportsdataverse-R/stargazers/)

## **Our Authors**

- [Saiem Gilani](https://twitter.com/saiemgilani)  
  [![@saiemgilani](https://img.shields.io/twitter/follow/saiemgilani?color=blue&label=%40saiemgilani&logo=twitter&style=for-the-badge)](https://twitter.com/saiemgilani)
  [![@saiemgilani](https://img.shields.io/github/followers/saiemgilani?color=eee&logo=Github&style=for-the-badge)](https://github.com/saiemgilani)

## **Citations**

To cite the [**`sportsdataverse`**](https://r.sportsdataverse.org) R
package in publications, use:

BibTex Citation

``` bibtex
@misc{saiemgilani2021sdv,
  author = {Gilani, Saiem},
  title = {sportsdataverse: The Set of R Packages for Sports Data.},
  url = {https://r.sportsdataverse.org},
  year = {2021}
}
```

## **R Packages in the SportsDataverse**

[![SportsDataverse package
wall](https://raw.githubusercontent.com/sportsdataverse/sportsdataverse-R/main/man/figures/sdv-wall.png)](https://R.sportsdataverse.org/)

### [**`cfbfastR`**](https://cfbfastR.sportsdataverse.org/)

[![Version-Number](https://img.shields.io/github/r-package/v/sportsdataverse/cfbfastR?label=cfbfastR&logo=R&style=for-the-badge)](https://github.com/sportsdataverse/cfbfastR)
[![R-CMD-check](https://img.shields.io/github/actions/workflow/status/sportsdataverse/cfbfastR/R-CMD-check.yaml?branch=main&label=R-CMD-Check&logo=R&logoColor=white&style=for-the-badge)](https://github.com/sportsdataverse/cfbfastR/actions/workflows/R-CMD-check.yaml)
[![CRAN
Status](https://img.shields.io/cran/v/cfbfastR?color=success&label=CRAN%20Version&logo=R&style=for-the-badge)](https://CRAN.R-project.org/package=cfbfastR)
[![CRAN
downloads](https://img.shields.io/badge/dynamic/json?style=for-the-badge&color=success&label=Downloads&query=%24%5B0%5D.downloads&url=https%3A%2F%2Fcranlogs.r-pkg.org%2Fdownloads%2Ftotal%2F2021-10-26%3Alast-day%2FcfbfastR)](https://CRAN.R-project.org/package=cfbfastR)

### [**`hoopR`**](https://hoopr.sportsdataverse.org/)

[![Version-Number](https://img.shields.io/github/r-package/v/sportsdataverse/hoopR?label=hoopR&logo=R&style=for-the-badge)](https://github.com/sportsdataverse/hoopR)
[![R-CMD-check](https://img.shields.io/github/actions/workflow/status/sportsdataverse/hoopR/R-CMD-check.yaml?branch=main&label=R-CMD-Check&logo=R&logoColor=white&style=for-the-badge)](https://github.com/sportsdataverse/hoopR/actions/workflows/R-CMD-check.yaml)
[![CRAN
Status](https://img.shields.io/cran/v/hoopR?color=success&label=CRAN%20Version&logo=R&style=for-the-badge)](https://CRAN.R-project.org/package=hoopR)
[![CRAN
downloads](https://img.shields.io/badge/dynamic/json?style=for-the-badge&color=success&label=Downloads&query=%24%5B0%5D.downloads&url=https%3A%2F%2Fcranlogs.r-pkg.org%2Fdownloads%2Ftotal%2F2021-10-26%3Alast-day%2FhoopR)](https://CRAN.R-project.org/package=hoopR)

### [**`wehoop`**](https://wehoop.sportsdataverse.org/)

[![Version-Number](https://img.shields.io/github/r-package/v/sportsdataverse/wehoop?label=wehoop&logo=R&style=for-the-badge)](https://github.com/sportsdataverse/wehoop)
[![R-CMD-check](https://img.shields.io/github/actions/workflow/status/sportsdataverse/wehoop/R-CMD-check.yaml?branch=main&label=R-CMD-Check&logo=R&logoColor=white&style=for-the-badge)](https://github.com/sportsdataverse/wehoop/actions/workflows/R-CMD-check.yaml)
[![CRAN
Status](https://img.shields.io/cran/v/wehoop?color=success&label=CRAN%20Version&logo=R&style=for-the-badge)](https://CRAN.R-project.org/package=wehoop)
[![CRAN
downloads](https://img.shields.io/badge/dynamic/json?style=for-the-badge&color=success&label=Downloads&query=%24%5B0%5D.downloads&url=https%3A%2F%2Fcranlogs.r-pkg.org%2Fdownloads%2Ftotal%2F2021-10-26%3Alast-day%2Fwehoop)](https://CRAN.R-project.org/package=wehoop)

### [**`fastRhockey`**](https://fastRhockey.sportsdataverse.org/)

[![Version-Number](https://img.shields.io/github/r-package/v/sportsdataverse/fastRhockey?label=fastRhockey&logo=R&style=for-the-badge)](https://github.com/sportsdataverse/fastRhockey)
[![R-CMD-check](https://img.shields.io/github/actions/workflow/status/sportsdataverse/fastRhockey/R-CMD-check.yaml?branch=main&label=R-CMD-Check&logo=R&logoColor=white&style=for-the-badge)](https://github.com/sportsdataverse/fastRhockey/actions/workflows/R-CMD-check.yaml)
[![CRAN
Status](https://img.shields.io/cran/v/fastRhockey?color=success&label=CRAN%20Version&logo=R&style=for-the-badge)](https://CRAN.R-project.org/package=fastRhockey)
[![CRAN
downloads](https://img.shields.io/badge/dynamic/json?style=for-the-badge&color=success&label=Downloads&query=%24%5B0%5D.downloads&url=https%3A%2F%2Fcranlogs.r-pkg.org%2Fdownloads%2Ftotal%2F2021-10-26%3Alast-day%2FfastRhockey)](https://CRAN.R-project.org/package=fastRhockey)

### [**`baseballr`**](https://billpetti.github.io/baseballr/)

[![Version-Number](https://img.shields.io/github/r-package/v/BillPetti/baseballr?label=baseballr&logo=R&style=for-the-badge)](https://github.com/BillPetti/baseballr)
[![R-CMD-check](https://img.shields.io/github/actions/workflow/status/BillPetti/baseballr/R-CMD-check.yaml?branch=master&label=R-CMD-Check&logo=R&logoColor=white&style=for-the-badge)](https://github.com/BillPetti/baseballr/actions/workflows/R-CMD-check.yaml)
[![CRAN
Status](https://img.shields.io/cran/v/baseballr?color=success&label=CRAN%20Version&logo=R&style=for-the-badge)](https://CRAN.R-project.org/package=baseballr)
[![CRAN
downloads](https://img.shields.io/badge/dynamic/json?style=for-the-badge&color=success&label=Downloads&query=%24%5B0%5D.downloads&url=https%3A%2F%2Fcranlogs.r-pkg.org%2Fdownloads%2Ftotal%2F2021-10-26%3Alast-day%2Fbaseballr)](https://CRAN.R-project.org/package=baseballr)

### [**`sportyR`**](https://sportyr.sportsdataverse.org/)

[![Version-Number](https://img.shields.io/github/r-package/v/sportsdataverse/sportyR?label=sportyR&logo=R&style=for-the-badge)](https://github.com/sportsdataverse/sportyR)
[![R-CMD-check](https://img.shields.io/github/actions/workflow/status/sportsdataverse/sportyR/R-CMD-check.yaml?branch=main&label=R-CMD-Check&logo=R&logoColor=white&style=for-the-badge)](https://github.com/sportsdataverse/sportyR/actions/workflows/R-CMD-check.yaml)
[![CRAN
Status](https://img.shields.io/cran/v/sportyR?color=success&label=CRAN%20Version&logo=R&style=for-the-badge)](https://CRAN.R-project.org/package=sportyR)
[![CRAN
downloads](https://img.shields.io/badge/dynamic/json?style=for-the-badge&color=success&label=Downloads&query=%24%5B0%5D.downloads&url=https%3A%2F%2Fcranlogs.r-pkg.org%2Fdownloads%2Ftotal%2F2021-10-26%3Alast-day%2FsportyR)](https://CRAN.R-project.org/package=sportyR)

### [**`oddsapiR`**](https://oddsapiR.sportsdataverse.org/)

[![Version-Number](https://img.shields.io/github/r-package/v/sportsdataverse/oddsapiR?label=oddsapiR&logo=R&style=for-the-badge)](https://github.com/sportsdataverse/oddsapiR)
[![R-CMD-check](https://img.shields.io/github/actions/workflow/status/sportsdataverse/oddsapiR/R-CMD-check.yaml?branch=main&label=R-CMD-Check&logo=R&logoColor=white&style=for-the-badge)](https://github.com/sportsdataverse/oddsapiR/actions/workflows/R-CMD-check.yaml)
[![CRAN
Status](https://img.shields.io/cran/v/oddsapiR?color=success&label=CRAN%20Version&logo=R&style=for-the-badge)](https://CRAN.R-project.org/package=oddsapiR)
[![CRAN
downloads](https://img.shields.io/badge/dynamic/json?style=for-the-badge&color=success&label=Downloads&query=%24%5B0%5D.downloads&url=https%3A%2F%2Fcranlogs.r-pkg.org%2Fdownloads%2Ftotal%2F2021-10-26%3Alast-day%2FoddsapiR)](https://CRAN.R-project.org/package=oddsapiR)

# Package index

## All functions

- [`get_core_functions()`](https://r.sportsdataverse.org/reference/get_core_functions.md)
  : List of all packages in the SportsDataverse
- [`sportsdataverse_deps()`](https://r.sportsdataverse.org/reference/sportsdataverse_deps.md)
  : List all sportsdataverse dependencies
- [`sportsdataverse_logo()`](https://r.sportsdataverse.org/reference/sportsdataverse_logo.md)
  : The sportsdataverse logo, using ASCII or Unicode characters
- [`sportsdataverse_packages()`](https://r.sportsdataverse.org/reference/sportsdataverse_packages.md)
  : List all packages in the sportsdataverse
- [`sportsdataverse_sitrep()`](https://r.sportsdataverse.org/reference/sportsdataverse_sitrep.md)
  : Get a situation report on the sportsdataverse
- [`sportsdataverse_update()`](https://r.sportsdataverse.org/reference/sportsdataverse_update.md)
  : Update sportsdataverse packages