README.Rmd

---
output: github_document
---

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

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

# ffespn

<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
[![CRAN status](https://www.r-pkg.org/badges/version/ffespn)](https://CRAN.R-project.org/package=ffespn)
[![R-CMD-check](https://github.com/dfs-with-r/ffespn/workflows/R-CMD-check/badge.svg)](https://github.com/dfs-with-r/ffespn/actions)
<!-- badges: end -->

The goal of ffespn is to get ESPN fantasy football projections. 

## Installation

You can install the development version of ffespn from github with:

``` r
remotes::install_github("dfs-with-r/ffespn")
```

## Example

This is a basic example which shows you how to get projections for week 0 (the preseason).

```{r example}
library(ffespn)

# use default espn league
qb <- ffespn_projections(2022, 0, "QB")
qb

# use custom league
dt <- ffespn_projections(2022, 0, "DT", league_id = "134971153")
dt
```