Skip to content

jimmyday12/fitzRoy

Repository files navigation

fitzRoy

Lifecycle: stable R-CMD-check Codecov test coverage CRAN status CRAN RStudio mirror downloads CRAN RStudio total downloads

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:

install.packages("fitzRoy")

Or install the development version from GitHub with:

# 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 to quickly get going with data analysis.

The main functions are fetch_fixture, fetch_lineup, fetch_results, fetch_ladder and fetch_player_stats.

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 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 for details on how to access it.

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.

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. By contributing to this project, you agree to abide by its terms.