try({}) in examples

BillPetti · Jan 15, 2024 · edaf74e · edaf74e
1 parent 4c40362
commit edaf74e
Show file tree

Hide file tree

Showing 40 changed files with 114 additions and 85 deletions.
diff --git a/R/fg_milb_pitcher_game_logs.R b/R/fg_milb_pitcher_game_logs.R
@@ -69,7 +69,7 @@
 #' @importFrom tidyr separate
 #' @export
 #' @examples \donttest{
-#'   fg_milb_pitcher_game_logs(playerid = "sa3020682", year=2023)
+#'   try(fg_milb_pitcher_game_logs(playerid = "sa3020682", year=2023))
 #' }
 
 fg_milb_pitcher_game_logs <- function(playerid, year) {

diff --git a/R/fg_pitcher_leaders.R b/R/fg_pitcher_leaders.R
@@ -449,7 +449,7 @@
 #' @import rvest 
 #' @export
 #' @examples \donttest{
-#'   fg_pitcher_leaders(startseason = 2023, endseason = 2023)
+#'   try(fg_pitcher_leaders(startseason = 2023, endseason = 2023))
 #' }
 fg_pitcher_leaders <- function(
     age = "",

diff --git a/R/fg_team_fielder.R b/R/fg_team_fielder.R
@@ -81,7 +81,7 @@
 #' @import rvest 
 #' @export
 #' @examples \donttest{
-#'   fg_team_fielder(startseason = 2023, endseason = 2023, qual = 150)
+#'   try(fg_team_fielder(startseason = 2023, endseason = 2023, qual = 150))
 #' }
 
 fg_team_fielder <- function(

diff --git a/R/fg_team_pitcher.R b/R/fg_team_pitcher.R
@@ -375,7 +375,7 @@
 #' @import rvest 
 #' @export
 #' @examples \donttest{
-#'   fg_team_pitcher(startseason = 2015, endseason = 2015, qual = 150)
+#'   try(fg_team_pitcher(startseason = 2015, endseason = 2015, qual = 150))
 #' }
 
 fg_team_pitcher <- function(

diff --git a/R/load_ncaa_baseball_pbp.R b/R/load_ncaa_baseball_pbp.R
@@ -10,7 +10,7 @@
 #' @return Returns a tibble
 #' @export
 #' @examples \donttest{
-#'   load_ncaa_baseball_pbp(seasons = 2021)
+#'   try(load_ncaa_baseball_pbp(seasons = 2021))
 #' }
 load_ncaa_baseball_pbp <- function(seasons = most_recent_ncaa_baseball_season(), ...,
                               dbConnection = NULL, tablename = NULL) {

diff --git a/R/load_ncaa_baseball_schedule.R b/R/load_ncaa_baseball_schedule.R
@@ -9,9 +9,9 @@
 #' @param tablename The name of the schedule data table within the database
 #' @return Returns a tibble
 #' @export
-#' @examples 
-#'   load_ncaa_baseball_schedule(seasons = 2022)
-#' 
+#' @examples \donttest{
+#'   try(load_ncaa_baseball_schedule(seasons = 2022))
+#' }
 load_ncaa_baseball_schedule <- function(seasons = most_recent_ncaa_baseball_season(), ...,
                               dbConnection = NULL, tablename = NULL) {
   old <- options(list(stringsAsFactors = FALSE, scipen = 999))

diff --git a/R/load_ncaa_baseball_season_ids.R b/R/load_ncaa_baseball_season_ids.R
@@ -9,9 +9,9 @@
 #' @param tablename The name of the data table within the database
 #' @return Returns a tibble
 #' @export
-#' @examples 
-#'   load_ncaa_baseball_season_ids()
-#' 
+#' @examples \donttest{
+#'   try(load_ncaa_baseball_season_ids())
+#' }
 load_ncaa_baseball_season_ids <- function(...,
                               dbConnection = NULL, tablename = NULL) {
   old <- options(list(stringsAsFactors = FALSE, scipen = 999))

diff --git a/R/load_ncaa_baseball_teams.R b/R/load_ncaa_baseball_teams.R
@@ -9,9 +9,9 @@
 #' @param tablename The name of the data table within the database
 #' @return Returns a tibble
 #' @export
-#' @examples 
-#'   load_ncaa_baseball_teams()
-#' 
+#' @examples \donttest{
+#'   try(load_ncaa_baseball_teams())
+#' }
 load_ncaa_baseball_teams <- function(...,
                               dbConnection = NULL, tablename = NULL) {
   old <- options(list(stringsAsFactors = FALSE, scipen = 999))

diff --git a/R/metrics_fip_plus.R b/R/metrics_fip_plus.R
@@ -60,8 +60,10 @@
 #' @import rvest
 #' @export
 #' @examples \donttest{
-#'   df <- bref_daily_pitcher("2015-04-05", "2015-04-30")
-#'   try(fip_plus(df))
+#'   try({
+#'     df <- bref_daily_pitcher("2015-04-05", "2015-04-30")
+#'     fip_plus(df)
+#'   })
 #' }
 
 fip_plus <- function(df) {

diff --git a/R/metrics_linear_weights_savant.R b/R/metrics_linear_weights_savant.R
@@ -16,13 +16,14 @@
 #'   
 #' @export 
 #' @examples \donttest{
-#'   df <- statcast_search(start_date = "2016-04-06", end_date = "2016-04-15", 
-#'                         playerid = 621043, player_type = 'batter') 
-#'   df <- run_expectancy_code(df, level = "plate appearances")
-#'   try(linear_weights_savant(df, level = "plate appearance"))
+#'  try({
+#'    df <- statcast_search(start_date = "2016-04-06", end_date = "2016-04-15", 
+#'                          playerid = 621043, player_type = 'batter') 
+#'    df <- run_expectancy_code(df, level = "plate appearances")
+#'    linear_weights_savant(df, level = "plate appearance")
+#'  })
 #' }
 
-
 linear_weights_savant <- function (df, level = "plate appearance"){
 
   if(level == "plate appearance") {

diff --git a/R/metrics_run_expectancy_code.R b/R/metrics_run_expectancy_code.R
@@ -120,9 +120,11 @@
 #' @importFrom rlang .data
 #' @export
 #' @examples \donttest{
-#'   df <- statcast_search(start_date = "2016-04-06", end_date = "2016-04-15", 
-#'                         playerid = 621043, player_type = 'batter') 
-#'   try(run_expectancy_code(df, level = "plate appearances"))
+#'  try({
+#'    df <- statcast_search(start_date = "2016-04-06", end_date = "2016-04-15", 
+#'                          playerid = 621043, player_type = 'batter') 
+#'    run_expectancy_code(df, level = "plate appearances")
+#'  })
 #' }
 
 run_expectancy_code <- function(df, level = "plate appearance"){

diff --git a/R/metrics_team_consistency.R b/R/metrics_team_consistency.R
@@ -13,8 +13,9 @@
 #' @import rvest 
 #' @export
 #' @details 
+#' ```r
 #'   try(team_consistency(year=2021))
-#' 
+#' ```
 
 team_consistency <- function(year) {
 

diff --git a/R/metrics_woba_plus.R b/R/metrics_woba_plus.R
@@ -43,8 +43,10 @@
 #' @import rvest 
 #' @export
 #' @examples \donttest{
-#'   df <- bref_daily_batter("2015-08-01", "2015-10-03") 
-#'   try(woba_plus(df))
+#'  try({
+#'    df <- bref_daily_batter("2015-08-01", "2015-10-03") 
+#'    woba_plus(df)
+#'  })
 #' }
 woba_plus <- function(df) {
 

diff --git a/R/mlb_award.R b/R/mlb_award.R
@@ -47,9 +47,4 @@
 #' ```
 #' 
 #' 
-#' 
-#' 
-#' 
-#' 
-#' 
 NULL
diff --git a/R/mlb_player_status_codes.R b/R/mlb_player_status_codes.R
@@ -6,7 +6,7 @@
 #'  |player_status_description  |character |
 #' @export
 #' @examples \donttest{
-#'   mlb_player_status_codes()
+#'   try(mlb_player_status_codes())
 #' }
 mlb_player_status_codes <- function(){
 

diff --git a/R/mlb_seasons.R b/R/mlb_seasons.R
@@ -32,7 +32,7 @@
 #' @export
 #'
 #' @examples \donttest{
-#'  mlb_seasons(sport_id = 1)
+#'  try(mlb_seasons(sport_id = 1))
 #' }
 
 mlb_seasons <- function(sport_id = 1,

diff --git a/R/mlb_seasons_all.R b/R/mlb_seasons_all.R
@@ -34,7 +34,7 @@
 #' @export
 #'
 #' @examples \donttest{
-#'  mlb_seasons_all(sport_id = 1)
+#'  try(mlb_seasons_all(sport_id = 1))
 #' }
 
 mlb_seasons_all <- function(sport_id = 1,

diff --git a/R/sc_statcast_search.R b/R/sc_statcast_search.R
@@ -411,10 +411,12 @@ statcast_search.default <- function(start_date = Sys.Date() - 1, end_date = Sys.
 #' @export
 #' @examples
 #' \donttest{
-#'   correa <- statcast_search_batters(start_date = "2016-04-06",
-#'     end_date = "2016-04-15", batterid = 621043)
-#'   daily <- statcast_search_batters(start_date = "2016-04-06",
-#'     end_date = "2016-04-06", batterid = NULL)
+#'   try({
+#'     correa <- statcast_search_batters(start_date = "2016-04-06",
+#'       end_date = "2016-04-15", batterid = 621043)
+#'     daily <- statcast_search_batters(start_date = "2016-04-06",
+#'       end_date = "2016-04-06", batterid = NULL)
+#'   })
 #' }
 
 statcast_search_batters <- function(start_date, end_date, batterid = NULL, ...) {
@@ -525,10 +527,12 @@ statcast_search_batters <- function(start_date, end_date, batterid = NULL, ...)
 #' @export
 #' @examples
 #' \donttest{
-#'   x <- statcast_search_pitchers(start_date = "2016-04-06",
-#'     end_date = "2016-04-15", pitcherid = 592789)
-#'   daily <- statcast_search_pitchers(start_date = "2016-04-06",
-#'     end_date = "2016-04-06", pitcherid = NULL)
+#'   try({
+#'     x <- statcast_search_pitchers(start_date = "2016-04-06",
+#'       end_date = "2016-04-15", pitcherid = 592789)
+#'     daily <- statcast_search_pitchers(start_date = "2016-04-06",
+#'       end_date = "2016-04-06", pitcherid = NULL)
+#'   })
 #' }
 
 statcast_search_pitchers <- function(start_date, end_date, pitcherid = NULL, ...) {

diff --git a/R/sch_label_statcast_imputed_data.R b/R/sch_label_statcast_imputed_data.R
@@ -116,9 +116,11 @@
 #' @export
 #' @examples
 #' \donttest{
-#'   statcast_df <- statcast_search("2017-05-01", "2017-05-02")
-#'   sc_df <- label_statcast_imputed_data(statcast_df)
-#'   mean(sc_df$imputed)
+#'   try({
+#'     statcast_df <- statcast_search("2017-05-01", "2017-05-02")
+#'     sc_df <- label_statcast_imputed_data(statcast_df)
+#'     mean(sc_df$imputed)
+#'   })
 #' }
 label_statcast_imputed_data <- function(statcast_df, impute_file = NULL, 
                                         inverse_precision = 10000) {

diff --git a/R/sch_statline_from_statcast.R b/R/sch_statline_from_statcast.R
@@ -8,7 +8,7 @@
 #' @export
 #' @details
 #' ```r
-#' statline_from_statcast(df, base = "contact")
+#'   statline_from_statcast(df, base = "contact")
 #' ```
 
 statline_from_statcast <- function(df, base = "pa") {

diff --git a/cran-comments.md b/cran-comments.md
@@ -7,6 +7,8 @@ This is a minor release that primarily focused on parameter changes to the `fg_*
 - `fg_batter_leaders()`
 - `fg_pitcher_leaders()`
 - `fg_fielder_leaders()`
+
+Examples made more robust to adhere to graceful failing policies per CRAN review. Vignettes removed from package for simplicity. 
 
 
 

diff --git a/man/fg_milb_pitcher_game_logs.Rd b/man/fg_milb_pitcher_game_logs.Rd
diff --git a/man/fg_pitcher_leaders.Rd b/man/fg_pitcher_leaders.Rd
diff --git a/man/fg_team_fielder.Rd b/man/fg_team_fielder.Rd
diff --git a/man/fg_team_pitcher.Rd b/man/fg_team_pitcher.Rd
diff --git a/man/fip_plus.Rd b/man/fip_plus.Rd
diff --git a/man/label_statcast_imputed_data.Rd b/man/label_statcast_imputed_data.Rd
diff --git a/man/linear_weights_savant.Rd b/man/linear_weights_savant.Rd
diff --git a/man/load_ncaa_baseball_pbp.Rd b/man/load_ncaa_baseball_pbp.Rd
diff --git a/man/load_ncaa_baseball_schedule.Rd b/man/load_ncaa_baseball_schedule.Rd
diff --git a/man/load_ncaa_baseball_season_ids.Rd b/man/load_ncaa_baseball_season_ids.Rd
diff --git a/man/load_ncaa_baseball_teams.Rd b/man/load_ncaa_baseball_teams.Rd
diff --git a/man/mlb_player_status_codes.Rd b/man/mlb_player_status_codes.Rd
diff --git a/man/mlb_seasons.Rd b/man/mlb_seasons.Rd
diff --git a/man/mlb_seasons_all.Rd b/man/mlb_seasons_all.Rd
-Original file line number
+Diff line change
@@ Expand Up / @@ -47,9 +47,4 @@ @@
     #' ```
     #'
     #'
-    #'
-    #'
-    #'
-    #'
-    #'
     NULL