From 126d168d1b842c69192a2db7bc6d3df4920bb19f Mon Sep 17 00:00:00 2001 From: Sebastian Carl Date: Wed, 11 Oct 2023 17:25:44 +0200 Subject: [PATCH] accept file_type arg for ftn data --- DESCRIPTION | 2 +- R/load_ftn_charting.R | 9 +++++++-- man/load_ftn_charting.Rd | 8 +++++++- 3 files changed, 15 insertions(+), 4 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 534871fa..e7f9f6f5 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: nflreadr Title: Download 'nflverse' Data -Version: 1.4.0.08 +Version: 1.4.0.09 Authors@R: c( person("Tan", "Ho", , "tan@tanho.ca", role = c("aut", "cre", "cph"), comment = c(ORCID = "0000-0001-8388-5155")), diff --git a/R/load_ftn_charting.R b/R/load_ftn_charting.R index 442e7ae1..5917019f 100644 --- a/R/load_ftn_charting.R +++ b/R/load_ftn_charting.R @@ -8,6 +8,8 @@ #' #' @param seasons a numeric vector of seasons to return, defaults to most recent season. #' If set to `TRUE`, returns all available data. Data available from 2022 onwards. +#' @param file_type One of `c("rds", "qs", "csv", "parquet")`. Can also be set globally with +#' `options(nflreadr.prefer)` #' #' @author FTN Data #' @source FTNData.com @@ -27,7 +29,8 @@ #' @family ftn_charting #' #' @export -load_ftn_charting <- function(seasons = most_recent_season()){ +load_ftn_charting <- function(seasons = most_recent_season(), + file_type = getOption("nflreadr.prefer", default = "rds")){ if(isTRUE(seasons)) seasons <- 2022:most_recent_season() @@ -35,7 +38,9 @@ load_ftn_charting <- function(seasons = most_recent_season()){ seasons >= 2022, seasons <= most_recent_season()) - urls <- glue::glue("https://github.com/nflverse/nflverse-data/releases/download/ftn_charting/ftn_charting_{seasons}.rds") + file_type <- rlang::arg_match0(file_type, c("rds", "csv", "parquet", "qs")) + + urls <- glue::glue("https://github.com/nflverse/nflverse-data/releases/download/ftn_charting/ftn_charting_{seasons}.{file_type}") out <- load_from_url( urls, diff --git a/man/load_ftn_charting.Rd b/man/load_ftn_charting.Rd index 334c3afb..fe04fcf5 100644 --- a/man/load_ftn_charting.Rd +++ b/man/load_ftn_charting.Rd @@ -7,11 +7,17 @@ FTNData.com } \usage{ -load_ftn_charting(seasons = most_recent_season()) +load_ftn_charting( + seasons = most_recent_season(), + file_type = getOption("nflreadr.prefer", default = "rds") +) } \arguments{ \item{seasons}{a numeric vector of seasons to return, defaults to most recent season. If set to \code{TRUE}, returns all available data. Data available from 2022 onwards.} + +\item{file_type}{One of \code{c("rds", "qs", "csv", "parquet")}. Can also be set globally with +\code{options(nflreadr.prefer)}} } \value{ Play-level manual charting data from FTN Data