Repository files navigation

fitzRoy aims to provide a consistent and reliable API to various datasources of both the Mens and Womens competitions of the AFL. Thesefunctions provide easy and tidy access to data such as fixtures, resultsand statistics from various data sources.

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")

The primary functions infitzRoy are thefetch_* functions. Theseprovide access to the most common types of data using a consistent API.View theQuick StartVignette toquickly get going with data analysis.

The main functions arefetch_fixture,fetch_lineup,fetch_results,fetch_ladder andfetch_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 themain fetchfunctionsto learn more about how these functions work.

From 2019, we are able to provide access to AFL Women’s data. Read thefullAFL WomensVingettefor 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()

An experimental feature as of version 1.2.0 is returning non-AFL relateddata. This only works for the sourceAFL but there are other compsthat are available. These comps do not have as much data as the AFLM andAFLW 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 aContributorCode ofConduct. Bycontributing to this project, you agree to abide by its terms.