Data

Tools

Indexes

Applications

Experiments

Open Source Science

fitzroy

A set of functions to easily access AFL data

https://github.com/jimmyday12/fitzroy

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    2 of 21 committers (9.5%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (19.0%) to scientific vocabulary

Keywords from Contributors

geo
Last synced: 10 months ago · JSON representation

Repository

A set of functions to easily access AFL data

Basic Info
Statistics
  • Stars: 138
  • Watchers: 16
  • Forks: 30
  • Open Issues: 11
  • Releases: 13
Created over 8 years ago · Last pushed 10 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Support

README.Rmd 

---
output: github_document
---



```{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 Hex logo for the fitzRoy package

[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![R-CMD-check](https://github.com/jimmyday12/fitzRoy/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jimmyday12/fitzRoy/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/jimmyday12/fitzRoy/branch/main/graph/badge.svg)](https://app.codecov.io/gh/jimmyday12/fitzRoy?branch=main)
[![CRAN status](https://www.r-pkg.org/badges/version/fitzRoy)](https://CRAN.R-project.org/package=fitzRoy)
[![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/fitzRoy)](https://www.r-pkg.org/pkg/fitzRoy)
[![CRAN RStudio total downloads](https://cranlogs.r-pkg.org/badges/grand-total/fitzRoy)](https://www.r-pkg.org/pkg/fitzRoy)




## 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.

Owner

  • Name: James Day
  • Login: jimmyday12
  • Kind: user
  • Location: Melbourne

GitHub Events

Total
  • Create event: 3
  • Release event: 1
  • Issues event: 36
  • Watch event: 8
  • Delete event: 2
  • Issue comment event: 37
  • Push event: 32
  • Pull request review comment event: 3
  • Pull request review event: 6
  • Pull request event: 30
  • Fork event: 4
Last Year
  • Create event: 3
  • Release event: 1
  • Issues event: 36
  • Watch event: 8
  • Delete event: 2
  • Issue comment event: 37
  • Push event: 32
  • Pull request review comment event: 3
  • Pull request review event: 6
  • Pull request event: 30
  • Fork event: 4

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 839
  • Total Committers: 21
  • Avg Commits per committer: 39.952
  • Development Distribution Score (DDS): 0.464
Past Year
  • Commits: 35
  • Committers: 6
  • Avg Commits per committer: 5.833
  • Development Distribution Score (DDS): 0.2
Top Committers
Name Email Commits
James Day j****y@g****m 450
jimmyday12 j****y@J****t 143
James Day j****y@f****m 61
Craig Franklin c****n@g****m 52
James Day 1****2 42
Oscar Lane l****r@g****m 32
James Day j****y@J****m 13
Matt m****e@o****m 8
Jason j****c@r****u 6
jlholden26 7****6 5
James Day j****y@J****l 4
Mathew Ling m****g@d****u 4
Matthew Erbs m****s@m****m 3
Analysis of AFL a****l@g****m 3
tylurp t****1@g****m 3
t-gummer t****r@g****m 2
Hadley Wickham h****m@g****m 2
peteowen1 p****1@h****k 2
James Baird j****4@g****m 2
Hamish h****e@f****u 1
James Day j****y@J****l 1
Committer Domains (Top 20 + Academic)
flinders.edu.au: 1 hotmail.co.uk: 1 merbla.com: 1 deakin.edu.au: 1 reece.com.au: 1 jds-macbook-pro.modem: 1 fusionsport.com: 1 jds-macbook-pro.brisbane.fusion.sport: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 117
  • Total pull requests: 84
  • Average time to close issues: 10 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 49
  • Total pull request authors: 13
  • Average comments per issue: 1.54
  • Average comments per pull request: 0.89
  • Merged pull requests: 65
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 18
  • Pull requests: 27
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 3 days
  • Issue authors: 10
  • Pull request authors: 4
  • Average comments per issue: 1.06
  • Average comments per pull request: 0.74
  • Merged pull requests: 14
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • jimmyday12 (27)
  • TonyCorke (6)
  • cfranklin11 (6)
  • insightlane (5)
  • liam-crow (4)
  • peteowen1 (4)
  • SingSing2020 (4)
  • DanielTomaro13 (4)
  • jaidenpopowski (3)
  • JaseZiv (3)
  • neilfws (3)
  • nandania-sportsbet (3)
  • jaytaytay (2)
  • jt026 (2)
  • hamgamb (2)
Pull Request Authors
  • peteowen1 (26)
  • jimmyday12 (19)
  • DanielTomaro13 (18)
  • cfranklin11 (6)
  • JaseZiv (4)
  • jlholden26 (3)
  • Fryzigg (2)
  • bairdj (2)
  • p4stoboy (2)
  • hamgamb (1)
  • t-gummer (1)
  • merbla (1)
  • hadley (1)
Top Labels
Issue Labels
data-bug (12) feature (6) bug (4) cant-reproduce (1) wip (1) good first issue :heart: (1)
Pull Request Labels

Packages

  • Total packages: 3
  • Total downloads:
    • cran 580 last-month
  • Total docker downloads: 41,971
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 38
  • Total maintainers: 1
proxy.golang.org: github.com/jimmyday12/fitzroy
  • Versions: 13
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.5%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 10 months ago
proxy.golang.org: github.com/jimmyday12/fitzRoy
  • Versions: 13
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.5%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 10 months ago
cran.r-project.org: fitzRoy

Easily Scrape and Process AFL Data

  • Versions: 12
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 580 Last month
  • Docker Downloads: 41,971
Rankings
Docker downloads count: 0.6%
Forks count: 2.7%
Stargazers count: 3.4%
Average: 15.3%
Dependent repos count: 23.9%
Dependent packages count: 28.7%
Downloads: 32.6%
Maintainers (1)
jamesthomasday@gmail.com
Last synced: 10 months ago

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.4.1 composite
  • actions/checkout v3 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pr-commands.yaml actions
  • actions/checkout v2 composite
  • actions/checkout v3 composite
  • r-lib/actions/pr-fetch v2 composite
  • r-lib/actions/pr-push v1 composite
  • r-lib/actions/pr-push v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/render-readme.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
DESCRIPTION cran
  • R >= 3.5 depends
  • cli * imports
  • dplyr * imports
  • glue * imports
  • httr * imports
  • jsonlite * imports
  • lubridate * imports
  • magrittr * imports
  • progress * imports
  • purrr * imports
  • readr * imports
  • rlang >= 0.1.2 imports
  • rvest * imports
  • stringr >= 1.3.0 imports
  • tibble * imports
  • tidyr >= 1.0.0 imports
  • tidyselect * imports
  • xml2 * imports
  • covr * suggests
  • curl * suggests
  • elo * suggests
  • ggplot2 * suggests
  • knitr * suggests
  • rmarkdown * suggests
  • roxygen2 * suggests
  • spelling * suggests
  • testthat * suggests
docker/rstudio/Dockerfile docker
  • rocker/rstudio 3.4.1 build