README.Rmd

---
output: github_document
---

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

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

# worldfootballR <img src="man/figures/logo.png" align="right" width="181" height="201"/>

<!-- badges: start -->
[![Travis build status](https://travis-ci.org/JaseZiv/worldfootballR.svg?branch=main)](https://travis-ci.org/JaseZiv/worldfootballR)
[![Codecov test coverage](https://codecov.io/gh/JaseZiv/worldfootballR/branch/master/graph/badge.svg)](https://codecov.io/gh/JaseZiv/worldfootballR?branch=master)
<!-- badges: end -->

## Overview

This package is designed to allow users to extract various world football results and player statistics data from fbref.com and valuations and transfer data from transfermarkt.com.


## Installation

You can install the `worldfootballR` package from github with:

```{r gh-installation, eval=FALSE}
# install.packages("devtools")
devtools::install_github("JaseZiv/worldfootballR")
```

```{r load_libs, warning=FALSE, message=FALSE}
library(worldfootballR)
```

***

## Contributing

### Issues and Feature Requests

When creating an issue, please include:

* Reproducible examples
* A brief description of what the expected results are
* If applicable, the fbref.com or transfermarkt.com page the observed behaviour is occuring on


### Pull Requests
Pull requests are also welcomed. Before doing so, please create an issue or email me with your idea.

Feel free to get in touch via email or twitter https://twitter.com/jaseziv

***


## Usage

Package vignettes have been built to help you get started with the package.

* For match-level data, see [here](https://jaseziv.github.io/worldfootballR/articles/extract-match-data.html)
* For season-level data, see [here](https://jaseziv.github.io/worldfootballR/articles/extract-season-data.html)
* for transfer histories and player market valuations, see [here](https://jaseziv.github.io/worldfootballR/articles/extract-valuation-data.html)