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

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

<!-- badges: start -->

[![R-CMD-check](https://github.com/awosoga/ceblR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/awosoga/ceblR/actions/workflows/R-CMD-check.yaml)
[![Version-Number](https://img.shields.io/github/r-package/v/awosoga/ceblR?label=ceblR)](https://github.com/awosoga/ceblR)
[![Lifecycle:
stable](https://img.shields.io/badge/lifecycle-stable-green.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![Codecov test
coverage](https://codecov.io/gh/awosoga/ceblR/branch/master/graph/badge.svg)](https://app.codecov.io/gh/awosoga/ceblR?branch=master)
<!-- badges: end -->

The goal of this package is to help people access clean and tidy data
from the [Canadian Elite Basketball League](https://www.cebl.ca/). It
provides functions to present data in an easy-to-use format that
provides greater detail and accessibility than official league sources.

## Installation

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

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

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

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

## Usage

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

### Acknowledgement

This package takes heavy inspiration from [Jason
Zivkovic’s](https://github.com/JaseZiv/)
[**`euroleagueR`**](https://github.com/JaseZiv/euroleagueR/) package.
Please give that package a star!
