README.Rmd

---
output: github_document
---

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

# fplr <img src="man/figures/logo.png" alt="" width="120" align="right" />

[![Build Status](https://travis-ci.org/ewenme/fplr.png)](https://travis-ci.org/ewenme/fplr) 
[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)

## Overview

fplr makes it quick 'n' easy to retrieve [Fantasy Premier League](https://fantasy.premierleague.com) (FPL) data programmatically, then work with it, all from R. 

## Installation

Get the latest development version of `fplr` from GitHub.

```{r, eval=FALSE}
# install.packages("remotes")
remotes::install_github("ewenme/fplr")
```

Because of the lack of dev support from FPL and possible API changes, the package is unlikely to be submitted to CRAN and will remain in an experimental [lifecycle](https://www.tidyverse.org/lifecycle/) for the foreseeable future.

## Usage

Refer to the [quickstart guide](https://ewenme.github.io/fplr/articles/fplr-quickstart.html) to get started. 
Still, here are some very basic examples of the functionality and practical applications of `fplr`.

### Get data

...on all players in the current FPL season.

```{r}
library(fplr)

players <- fpl_get_player_all()

players
```

## In-the-wild

[...xPoints?](https://ewen.io/2019/03/08/xpoints/)

```{r, echo=FALSE}
knitr::include_graphics("https://github.com/rbind/ewenme/raw/master/static/blog/2019-03-08-xPoints_files/figure-html/value-calc-1.png")
```

## Collaborators

If you want to contribute to the package, try and follow:

- Principles in Hadley Wickham's [R packages book](https://r-pkgs.org/)
- The GitHub fork/pull request [model](https://guides.github.com/introduction/flow/)

Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.