-
Notifications
You must be signed in to change notification settings - Fork 27
/
README.Rmd
104 lines (76 loc) · 4.11 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
---
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%"
)
```
```{r echo=FALSE, message=FALSE, warning=FALSE}
library(tidyverse)
# Get version and dependancy from description
version <- as.vector(read.dcf("DESCRIPTION")[, "Version"]) %>%
gsub("-", ".", .)
dep <- as.vector(read.dcf("DESCRIPTION")[, "Depends"]) %>%
stringr::str_extract("\\d+\\.*\\d+\\.*\\d*")
```
# fitzRoy <img src="man/figures/fitz_hex.png" align="right" width="120" height="139"/>
<!-- badges: start -->
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://github.com/jimmyday12/fitzRoy/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/jimmyday12/fitzRoy?branch=main)
[](https://CRAN.R-project.org/package=fitzRoy)
[](https://www.r-pkg.org/pkg/fitzRoy)
[](https://www.r-pkg.org/pkg/fitzRoy)
<!-- badges: end -->
## Overview
`fitzRoy` aims to provide a consistent and reliable API to various data sources of both the Mens and Womens competitions of the AFL. These functions provide easy and tidy access to data such as fixtures, results and statistics from various data sources.
## Installation
Install the released version of fitzRoy from CRAN:
```{r cran-installation, eval = FALSE}
install.packages("fitzRoy")
```
Or install the development version from GitHub with:
```{r gh-installation, eval = FALSE}
# install.packages("devtools")
devtools::install_github("jimmyday12/fitzRoy")
```
## Usage
The primary functions in `fitzRoy` are the `fetch_*` functions. These provide access to the most common types of data using a consistent API. View the [Quick Start Vignette](https://jimmyday12.github.io/fitzRoy/articles/fitzRoy.html) to quickly get going with data analysis.
The main functions are `fetch_fixture`, `fetch_lineup`, `fetch_results`, `fetch_ladder` and `fetch_player_stats`.
```{r fetch, eval=FALSE}
fetch_fixture(season = 2020, comp = "AFLM")
fetch_lineup(season = 2021, round_number = 1, comp = "AFLW")
fetch_results(season = 2020, round_number = 1, comp = "AFLW")
fetch_ladder(season = 2020, source = "squiggle")
fetch_player_stats(season = 2020, source = "fryzigg")
fetch_player_details(team = "Hawthorn", current = TRUE, source = "AFL")
```
See vignette on using the [main fetch functions](https://jimmyday12.github.io/fitzRoy/articles/main-fetch-functions.html) to learn more about how these functions work.
### AFL Womens data
From 2019, we are able to provide access to AFL Women's data. Read the full [AFL Womens Vingette](https://jimmyday12.github.io/fitzRoy/articles/womens-stats.html) for details on how to access it.
```{r aflw, eval=FALSE}
fetch_fixture(season = 2020, comp = "AFLW")
fetch_results(season = 2020, comp = "AFLW")
fetch_ladder(season = 2020, comp = "AFLW")
get_aflw_match_data()
```
### Non-AFL data
An experimental feature as of version 1.2.0 is returning non-AFL related data. This only works for the source `AFL` but there are other comps that are available. These comps do not have as much data as the AFLM and AFLW comps but some functions will work.
```{r, eval = FALSE}
fetch_fixture(2022, source = "AFL", comp = "VFL")
fetch_player_stats(2022, round = 1, source = "AFL", comp = "VFLW")
fetch_fixture(2022, source = "AFL", comp = "WAFL")
```
Available comps include
* "VFL"
* "VFLW"
* "WAFL"
* "U18B"
* "U18G"
---
Please note that the 'fitzRoy' project is released with a [Contributor Code of Conduct](https://jimmyday12.github.io/fitzRoy/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.