Skip to content

Commit 22f3a1c

Browse files
committed
docs
1 parent 61e4a74 commit 22f3a1c

11 files changed

+22
-19
lines changed

DESCRIPTION

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Authors@R: c(
1010
person("Camden", "Kay", , "camden.kay23@gmail.com", role = "ctb")
1111
)
1212
Description: Provides numerous utilities for acquiring and analyzing
13-
baseball data from online sources such as Baseball Reference <https://www.baseball-reference.com/>,
14-
FanGraphs <https://www.fangraphs.com/>, and the MLB Stats API <https://www.mlb.com/>.
13+
baseball data from online sources such as 'Baseball Reference' <https://www.baseball-reference.com/>,
14+
'FanGraphs' <https://www.fangraphs.com/>, and the 'MLB Stats' API <https://www.mlb.com/>.
1515
License: MIT + file LICENSE
1616
URL: https://billpetti.github.io/baseballr/,
1717
https://github.com/BillPetti/baseballr

R/load_ncaa_baseball_pbp.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
#' @param tablename The name of the schedule data table within the database
1010
#' @return Returns a tibble
1111
#' @export
12-
#' @examples \donttest{
12+
#' @examples
1313
#' load_ncaa_baseball_pbp(seasons = 2021)
14-
#' }
14+
#'
1515
load_ncaa_baseball_pbp <- function(seasons = most_recent_ncaa_baseball_season(), ...,
1616
dbConnection = NULL, tablename = NULL) {
1717
old <- options(list(stringsAsFactors = FALSE, scipen = 999))

R/load_ncaa_baseball_schedule.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
#' @param tablename The name of the schedule data table within the database
1010
#' @return Returns a tibble
1111
#' @export
12-
#' @examples \donttest{
12+
#' @examples
1313
#' load_ncaa_baseball_schedule(seasons = 2022)
14-
#' }
14+
#'
1515
load_ncaa_baseball_schedule <- function(seasons = most_recent_ncaa_baseball_season(), ...,
1616
dbConnection = NULL, tablename = NULL) {
1717
old <- options(list(stringsAsFactors = FALSE, scipen = 999))

R/load_ncaa_baseball_season_ids.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
#' @param tablename The name of the data table within the database
1010
#' @return Returns a tibble
1111
#' @export
12-
#' @examples \donttest{
12+
#' @examples
1313
#' load_ncaa_baseball_season_ids()
14-
#' }
14+
#'
1515
load_ncaa_baseball_season_ids <- function(...,
1616
dbConnection = NULL, tablename = NULL) {
1717
old <- options(list(stringsAsFactors = FALSE, scipen = 999))

R/load_ncaa_baseball_teams.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
#' @param tablename The name of the data table within the database
1010
#' @return Returns a tibble
1111
#' @export
12-
#' @examples \donttest{
12+
#' @examples
1313
#' load_ncaa_baseball_teams()
14-
#' }
14+
#'
1515
load_ncaa_baseball_teams <- function(...,
1616
dbConnection = NULL, tablename = NULL) {
1717
old <- options(list(stringsAsFactors = FALSE, scipen = 999))

cran-comments.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,13 @@ This is a minor release that
3535
fg_batter_leaders(), fg_pitcher_leaders(), chadwick_player_lu()
3636
* Updates for tidyselect deprecation of data masking for related dplyr and tidyr functions
3737
* Also resolves the issue cited with vignette by CRAN maintainers
38+
* Unwraps several examples for testing purposes. I will not unwrap more because they connect to
39+
outside internet resources. This can have adverse affects on the API's accessed.
40+
Our own testing is automated via GitHub Actions and is extensive enough that I feel confident
41+
we will catch errors in a sufficiently quick fashion. I simply am not interested in an API
42+
resource being temporarily down or misfiring triggering a CRAN alert for me. Everything in the
43+
package connects to the internet, so I try to be polite on giving examples that will be repeatedly
44+
called.
3845

3946
## R CMD check results
4047

man/baseballr-package.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/load_ncaa_baseball_pbp.Rd

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/load_ncaa_baseball_schedule.Rd

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/load_ncaa_baseball_season_ids.Rd

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)