add to docs

nflverse · Aug 8, 2023 · 51acee7 · 51acee7
1 parent 7a0e36b
commit 51acee7
Show file tree

Hide file tree

Showing 67 changed files with 107 additions and 39 deletions.
diff --git a/R/from_url.R b/R/from_url.R
@@ -10,6 +10,7 @@
 #' @return a dataframe, possibly of type `nflverse_data`
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents cran errors
 #'   urls <- c("https://github.com/nflverse/nflverse-data/releases/download/rosters/roster_2020.csv",
@@ -48,6 +49,7 @@ load_from_url <- function(url, ..., seasons = TRUE, nflverse = FALSE){
 #' @return a dataframe as created by [`readRDS()`]
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents cran errors
 #'   rds_from_url("https://github.com/nflverse/nflverse-data/releases/download/test/combines.rds")
@@ -80,6 +82,7 @@ rds_from_url <- function(url) {
 #' @return a dataframe as created by [`data.table::fread()`]
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents cran errors
 #'   csv_from_url("https://github.com/nflverse/nflverse-data/releases/download/test/combines.csv")
@@ -102,6 +105,7 @@ csv_from_url <- function(...){
 #' @return a raw vector
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents CRAN errors
 #' head(raw_from_url(
@@ -138,6 +142,7 @@ raw_from_url <- function(url){
 #' @return a dataframe as parsed by [`arrow::read_parquet()`]
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({
 #'   parquet_from_url(
@@ -175,6 +180,7 @@ parquet_from_url <- function(url){
 #' @return a dataframe as parsed by [`qs::qdeserialize()`]
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({
 #'   qs_from_url(

diff --git a/R/load_combine.R b/R/load_combine.R
@@ -6,6 +6,7 @@
 #' @param file_type One of `c("rds", "qs", "csv", "parquet")`. Can also be set globally with
 #' `options(nflreadr.prefer)`
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents cran errors
 #'   load_combine()

diff --git a/R/load_contracts.R b/R/load_contracts.R
@@ -6,6 +6,7 @@
 #'   Can also be set globally with options(nflreadr.prefer)
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents cran errors
 #'   load_contracts()

diff --git a/R/load_depth_charts.R b/R/load_depth_charts.R
@@ -7,6 +7,7 @@
 #' `options(nflreadr.prefer)`
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents cran errors
 #'   load_depth_charts(2020)

diff --git a/R/load_draft_picks.R b/R/load_draft_picks.R
@@ -7,6 +7,7 @@
 #' `options(nflreadr.prefer)`
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents cran errors
 #'   load_draft_picks()

diff --git a/R/load_espn_qbr.R b/R/load_espn_qbr.R
@@ -5,6 +5,7 @@
 #' @param summary_type One of "season" or "weekly", defaults to season
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #'     load_espn_qbr("nfl",2020)
 #' }

diff --git a/R/load_ffverse.R b/R/load_ffverse.R
@@ -5,6 +5,7 @@
 #' @return a dataframe of player IDs
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents cran errors
 #' load_ff_playerids()

diff --git a/R/load_injuries.R b/R/load_injuries.R
@@ -7,6 +7,7 @@
 #' `options(nflreadr.prefer)`
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({# prevents cran errors
 #'     load_injuries(2020)

diff --git a/R/load_nextgen_stats.R b/R/load_nextgen_stats.R
@@ -12,6 +12,7 @@
 #'
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents cran errors
 #'   load_nextgen_stats(stat_type = "passing")

diff --git a/R/load_officials.R b/R/load_officials.R
@@ -7,6 +7,7 @@
 #' `options(nflreadr.prefer)`
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents cran errors
 #'   load_officials()

diff --git a/R/load_participation.R b/R/load_participation.R
@@ -10,6 +10,7 @@
 #' @return A dataframe of participation data, optionally merged with play by play
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents cran errors
 #'   load_participation(seasons = 2020, include_pbp = TRUE)

diff --git a/R/load_pbp.R b/R/load_pbp.R
@@ -10,6 +10,7 @@
 #' (see below) for all given `seasons`
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents cran errors
 #'   load_pbp(2019:2020)

diff --git a/R/load_pfr_advstats.R b/R/load_pfr_advstats.R
@@ -6,6 +6,7 @@
 #' @param seasons a numeric vector specifying what seasons to return, if `TRUE` returns all available data
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #'   load_pfr_passing()
 #' }
@@ -38,6 +39,7 @@ load_pfr_passing <- function(seasons = TRUE){
 #'
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents cran errors
 #'   load_pfr_advstats()

diff --git a/R/load_player_stats.R b/R/load_player_stats.R
@@ -6,6 +6,7 @@
 #' `options(nflreadr.prefer)`
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents cran errors
 #'   load_player_stats()

diff --git a/R/load_players.R b/R/load_players.R
@@ -5,6 +5,7 @@
 #' `options(nflreadr.prefer)`
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents cran errors
 #'   load_players()

diff --git a/R/load_rosters.R b/R/load_rosters.R
@@ -7,6 +7,7 @@
 #' `options(nflreadr.prefer)`
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents cran errors
 #'   load_rosters(2020)

diff --git a/R/load_rosters_weekly.R b/R/load_rosters_weekly.R
@@ -9,6 +9,7 @@
 #' `options(nflreadr.prefer)`
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents cran errors
 #'   load_rosters_weekly(2020)

diff --git a/R/load_schedules.R b/R/load_schedules.R
@@ -11,6 +11,7 @@
 #' @seealso Issues with this data should be filed here: <https://github.com/nflverse/nfldata>
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents cran errors
 #'  load_schedules(2020)

diff --git a/R/load_snap_counts.R b/R/load_snap_counts.R
@@ -8,6 +8,7 @@
 #' `options(nflreadr.prefer)`
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #'   try({ # prevents CRAN errors
 #'   load_snap_counts()

diff --git a/R/load_teams.R b/R/load_teams.R
@@ -2,9 +2,10 @@
 #'
 #' @description Loads team graphics, colors, and logos - useful for plots!
 #'
-#' @param current If `TRUE` (the default), returns a standardized list of current teams only, 
+#' @param current If `TRUE` (the default), returns a standardized list of current teams only,
 #' with abbreviations as per [nflreadr::team_abbr_mapping].
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents cran errors
 #'   load_teams()

diff --git a/R/load_trades.R b/R/load_trades.R
@@ -11,6 +11,7 @@
 #' @seealso Issues with this data should be filed here: <https://github.com/nflverse/nfldata>
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #'  load_trades(2020)
 #' }

diff --git a/R/utils.R b/R/utils.R
@@ -35,7 +35,6 @@ print.nflverse_data <- function(x,...){
 #' @export
 #' @keywords internal
 rbindlist_with_attrs <- function(dflist){
-
   nflverse_timestamp <- attr(dflist[[length(dflist)]], "nflverse_timestamp")
   nflverse_type <- attr(dflist[[length(dflist)]], "nflverse_type")
   out <- data.table::rbindlist(dflist, use.names = TRUE, fill = TRUE)

diff --git a/R/utils_cran.R b/R/utils_cran.R
@@ -4,6 +4,7 @@
 #' limiting data.table CPU cores for examples/tests
 #'
 #' @export
+#' @keywords internal
 .for_cran <- function(){
 
   cores <- min(

diff --git a/R/utils_download_nflverse.R b/R/utils_download_nflverse.R
@@ -13,7 +13,8 @@
 #' @param use_hive whether to create hive-style partition folders for each season, e.g. `"~/pbp/.season=2021/pbp.csv"`
 #' @param .token a GitHub API token, `"default"` uses `gh::gh_token()`
 #'
-#' @examples {
+#' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({
 #'   ## could also set options like
@@ -24,7 +25,6 @@
 #'   list.files(tempdir(),pattern = ".parquet$") # check that files were downloaded!
 #' })
 #' }
-#' }
 #' @export
 nflverse_download <- function(...,
                               folder_path = getOption("nflreadr.download_path", default = "."),
@@ -115,21 +115,26 @@ nflverse_download <- function(...,
 #'
 #' @param .token a GitHub API token, `"default"` uses `gh::gh_token()`
 #'
-#' @return A dataframe containing release names, release descriptions, and
-#'   other relevant release information.
-#' @export
 #' @examples
-#' \donttest{
+#' \dontshow{
+#' .for_cran()
 #' # Change option for better output
 #' old <- options(piggyback.verbose = FALSE)
+#' }
+#' \donttest{
 #'
 #' try( # avoids cran failures, can skip in normal usage
 #' nflverse_releases()
 #' )
-#'
+#' }
+#' \dontshow{
 #' # Restore old options
 #' options(old)
 #' }
+#'
+#' @return A dataframe containing release names, release descriptions, and
+#'   other relevant release information.
+#' @export
 nflverse_releases <- function(.token = "default") {
   rlang::check_installed("piggyback (>= 0.1.2)", "gh")
   if(.token == "default") .token <- gh::gh_token()

diff --git a/R/utils_gameid.R b/R/utils_gameid.R
@@ -8,6 +8,7 @@
 #' @export
 #'
 #' @examples
+#' \dontshow{.for_cran()}
 #' nflverse_game_id(2022, 2, "LAC", "KC")
 nflverse_game_id <- function(season,
                              week,

diff --git a/R/utils_join_coalesce.R b/R/utils_join_coalesce.R
@@ -18,7 +18,7 @@
 #'
 #'
 #' @examples
-#'
+#' \dontshow{.for_cran()}
 #' x <- data.frame(id1 = c(NA_character_,letters[1:4]), a = c(1,NA,3,NA,5), b = 1:5 * 10)
 #' y <- data.frame(id2 = c(letters[3:11],NA_character_), a = -(1:10), c = 1:10 * 100)
 #'

diff --git a/R/utils_name_cleaning.R b/R/utils_name_cleaning.R
@@ -16,6 +16,7 @@
 #'   with `NA` (depending on the value of `keep_non_matches`).
 #' @export
 #' @examples
+#' \dontshow{.for_cran()}
 #' x <- c("PIE", "LAR", "PIT", "CRD", "OAK", "SL")
 #' # use current location and keep non matches
 #' clean_team_abbrs(x)
@@ -60,7 +61,7 @@ clean_team_abbrs <- function(abbr, current_location = TRUE, keep_non_matches = T
 #' @return a character vector of cleaned names
 #'
 #' @examples
-#'
+#' \dontshow{.for_cran()}
 #' clean_player_names(c("A.J. Green", "Odell Beckham Jr.  ", "Le'Veon Bell Sr."))
 #'
 #' clean_player_names(c("Trubisky,      Mitch", "Atwell, Chatarius", "Elliott, Zeke", "Elijah Moore"),
@@ -117,22 +118,21 @@ clean_player_names <- function(player_name,
 #' @param invert a character vector of columns that gets inverted when referring to the away team (e.g. home spread = 1 gets converted to away_spread = -1)
 #'
 #' @examples
-#' \donttest{
+#' \dontshow{.for_cran()}
 #' # a small example dataframe
 #' s <- data.frame(
-#'    game_id = c("2020_20_TB_GB", "2020_20_BUF_KC", "2020_21_KC_TB"), 
-#'    game_type = c("CON", "CON", "SB"), 
-#'    away_team = c("TB", "BUF", "KC"), 
-#'    away_score = c(31L, 24L, 9L), 
-#'    home_team = c("GB", "KC", "TB"), 
-#'    home_score = c(26L, 38L, 31L), 
-#'    location = c("Home", "Home", "Neutral"), 
-#'    result = c(-5L, 14L, 22L), 
+#'    game_id = c("2020_20_TB_GB", "2020_20_BUF_KC", "2020_21_KC_TB"),
+#'    game_type = c("CON", "CON", "SB"),
+#'    away_team = c("TB", "BUF", "KC"),
+#'    away_score = c(31L, 24L, 9L),
+#'    home_team = c("GB", "KC", "TB"),
+#'    home_score = c(26L, 38L, 31L),
+#'    location = c("Home", "Home", "Neutral"),
+#'    result = c(-5L, 14L, 22L),
 #'    spread_line = c(3, 3, -3)
 #'  )
 #'
 #' clean_homeaway(s, invert = c("result","spread_line"))
-#' }
 #' @return a dataframe with one row per team (twice as long as the input dataframe)
 #' @export
 clean_homeaway <- function(dataframe, invert = NULL){

diff --git a/R/utils_progressively.R b/R/utils_progressively.R
@@ -8,7 +8,7 @@
 #' @param p a function such as one created by `progressr::progressor()` - also accepts purrr-style lambda functions.
 #'
 #' @examples
-#'
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({ # prevents cran errors
 #'

diff --git a/R/utils_sitrep.R b/R/utils_sitrep.R
@@ -20,6 +20,7 @@
 #' @param redact_path a logical indicating whether options that contain "path"
 #' in the name should be redacted, default = TRUE
 #' @examples
+#' \dontshow{.for_cran()}
 #' \donttest{
 #' try({
 #' nflverse_sitrep()

diff --git a/man/clean_homeaway.Rd b/man/clean_homeaway.Rd