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

# rvolleydata <a href="https://awosoga.github.io/rvolleydata/"><img src="man/figures/logo.svg" alt="rvolleydata website" align="right" height="139"/></a>

<!-- badges: start -->

[![downloads](https://cranlogs.r-pkg.org/badges/grand-total/rvolleydata)](https://cran.r-project.org/package=rvolleydata)
[![R-CMD-check](https://github.com/awosoga/rvolleydata/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/awosoga/rvolleydata/actions/workflows/R-CMD-check.yaml)
[![Version-Number](https://img.shields.io/github/r-package/v/awosoga/rvolleydata?label=rvolleydata)](https://github.com/awosoga/rvolleydata)
[![Lifecycle:
stable](https://img.shields.io/badge/lifecycle-stable-green.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)

<!-- badges: end -->

The goal of `rvolleydata` is to help people access clean and tidy data
from [League One Volleyball Pro (LOVB)](https://www.lovb.com/),
[Athletes Unlimited Pro Volleyball
(AU)](https://auprosports.com/volleyball/), and [Major League Volleyball
(MLV)](https://provolleyball.com/) leagues.

## Installations

You can install the CRAN version of
[**`rvolleydata`**](https://CRAN.R-project.org/package=rvolleydata)
with:

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

You can install the development version of rvolleydata from
[GitHub](https://github.com/awosoga/rvolleydata) with:

``` r
# install.packages("devtools")
devtools::install_github("awosoga/rvolleydata")
```

## Usage

Please refer to the [package
vignette](https://awosoga.github.io/rvolleydata/articles/rvolleydata-how-to-use)
for more information on how to use this library.

## Note

Some Athletes Unlimited (AU) data, such as from exhibition matches
against collegiate teams, is missing. Data from matches played during
the 2021 season are also not included due to incongruent data
structures.

## Acknowledgement

A big thanks to [Rebecca Lai](https://www.rebeccalai.net) for the
awesome logo design!
