Main Fetch functions
The goal of fitzRoy has been to provide a consistent and easy to use interface for accessing data from various sources. As of version 0.3.3.9000 of
fitzRoy, the package now contains a much more consistent API to do so. This is with the introduction of the main
Each function uses the same arguments and each argument should behave the same across all of the functions. While there may be some slight differences in behaviour between different sources of data, the goal will be to move towards a much more consistent pattern of behaviour.
There are a number of main functions
fetch_fixture - returns the fixture for a given round and season
fetch_lineup - returns the lineup any matches in a given round and season
fetch_results - returns the match results for a given round and season
fetch_ladder - returns the ladder for a given round and season
fetch_player_stats - returns the detailed player stats for a set of matches within a given round or season
fetch_player_details - returns details on players such as date of birth, height, weight and debut (depending on source)
Each function generally accepts 4 arguments. These are consistent between functions and provide sane and common defaults. The common arguments are:
season - the season or seasons to return data from. If NULL (the default), will return the season that matches
round_number- the round to return data from. If NULL (the default), will return data from all rounds
source - the source with which to return data from. Must be one of “AFL” (default), “footywire”, “fryzigg”, “afltables”, “squiggle”
comp - the competition to return data from. Must be one of “AFLM” (default) or “AFLW”. Not all data sources will have AFLW data.
All of the functions behave the same. The following are some examples using the
fetch_fixture function but can equally be applied to any of the family of
This is the same as
fetch_fixture(season = 2021, comp = "AFLM", source = "AFL")
We can return just one round instead of the whole fixture.
fetch_fixture(season = 2021, round_number = 2) %>%
select(compSeason.name, round.name, home.team.name, away.team.name, venue.name)
We could also return the AFLW fixture instead.
fetch_fixture(season = 2021, comp = "AFLW") %>%
Lastly - we can choose a different source. Note that the field names and even the names of the teams and/or venues will be different for difference sources.
fetch_fixture(2021, round_number = 1, source = "squiggle")
It should also be noted that the various sources of data have their own functions that can be called directly.
# The following are the same
fetch_fixture(2021, round_number = 5, source = "squiggle")
fetch_fixture_squiggle(2021, round_number = 5)
With these new functions we now have access to consistent AFLW data for the first time!
At a high level, any
fetch_ function will allow you to specify the that
comp = "AFLW and will return data. Please note that Womens data only exists when
source = "AFL", which is the default for all
Read the full AFL Womens Vingette for specific examples.