From f59622bc1fe29dc5130719b2602391faaf7bfeaf Mon Sep 17 00:00:00 2001 From: saiemgilani Date: Sat, 25 Nov 2023 17:44:25 -0500 Subject: [PATCH] fixing rd/latex issues from CRAN --- R/load_wbb.R | 19 +++++++++++-------- R/load_wnba.R | 20 ++++++++++++-------- man/update_wbb_db.Rd | 13 +++++-------- man/update_wnba_db.Rd | 13 +++++-------- 4 files changed, 33 insertions(+), 32 deletions(-) diff --git a/R/load_wbb.R b/R/load_wbb.R index bbf17a6b..671ec24b 100644 --- a/R/load_wbb.R +++ b/R/load_wbb.R @@ -262,10 +262,13 @@ load_wbb_games <- function(){ } +#' **Build/update wehoop WBB play-by-play database** #' @name update_wbb_db -#' @aliases update_wbb_db wbb_db wbb wbb_pbp_db +NULL + #' @title -#' **Update or create a wehoop play-by-play database** +#' **Update or create a wehoop WBB play-by-play database** +#' @rdname update_wbb_db #' @description update_wbb_db() updates or creates a database with `wehoop` #' play by play data of all completed and available games since 2002. #' @@ -280,15 +283,15 @@ load_wbb_games <- function(){ #' by play data table either for the whole wehoop era (with `force_rebuild = TRUE`) #' or just for specified seasons (e.g. `force_rebuild = c(2019, 2020)`). #' Please note the following behavior: -#' \itemize{ -#' \item{`force_rebuild = TRUE`}{: The data table with the name `tblname` +#' +#' - `force_rebuild = TRUE`: The data table with the name `tblname` #' will be removed completely and rebuilt from scratch. This is helpful when -#' new columns are added during the Off-Season.} -#' \item{`force_rebuild = c(2019, 2020)`}{: The data table with the name `tblname` +#' new columns are added during the Off-Season. +#' - `force_rebuild = c(2019, 2020)`: The data table with the name `tblname` #' will be preserved and only rows from the 2019 and 2020 seasons will be #' deleted and re-added. This is intended to be used for ongoing seasons because -#' ESPN's data provider can make changes to the underlying data during the week.} -#' } +#' ESPN's data provider can make changes to the underlying data during the week. +#' #' #' The parameter `db_connection` is intended for advanced users who want #' to use other DBI drivers, such as MariaDB, Postgres or odbc. Please note that diff --git a/R/load_wnba.R b/R/load_wnba.R index 92cc9d26..6161a2d4 100644 --- a/R/load_wnba.R +++ b/R/load_wnba.R @@ -249,10 +249,13 @@ load_wnba_games <- function(){ return(dat) } +#' **Build/update wehoop WNBA play-by-play database** #' @name update_wnba_db -#' @aliases update_wnba_db wnba_db wnba wnba_pbp_db +NULL + #' @title -#' **Update or create a wehoop play-by-play database** +#' **Update or create a wehoop WNBA play-by-play database** +#' @rdname update_wnba_db #' @description update_wnba_db() updates or creates a database with `wehoop` #' play by play data of all completed and available games since 2002. #' @@ -267,15 +270,16 @@ load_wnba_games <- function(){ #' by play data table either for the whole wehoop era (with `force_rebuild = TRUE`) #' or just for specified seasons (e.g. `force_rebuild = c(2019, 2020)`). #' Please note the following behavior: -#' \itemize{ -#' \item{`force_rebuild = TRUE`}{: The data table with the name `tblname` +#' +#' - `force_rebuild = TRUE`: The data table with the name `tblname` #' will be removed completely and rebuilt from scratch. This is helpful when -#' new columns are added during the Off-Season.} -#' \item{`force_rebuild = c(2019, 2020)`}{: The data table with the name `tblname` +#' new columns are added during the Off-Season. +#' - `force_rebuild = c(2019, 2020)`: The data table with the name `tblname` #' will be preserved and only rows from the 2019 and 2020 seasons will be #' deleted and re-added. This is intended to be used for ongoing seasons because -#' ESPN's data provider can make changes to the underlying data during the week.} -#' } +#' ESPN's data provider can make changes to the underlying data during the week. +#' +#' #' #' The parameter `db_connection` is intended for advanced users who want #' to use other DBI drivers, such as MariaDB, Postgres or odbc. Please note that diff --git a/man/update_wbb_db.Rd b/man/update_wbb_db.Rd index a6ac5636..e04c0ea2 100644 --- a/man/update_wbb_db.Rd +++ b/man/update_wbb_db.Rd @@ -2,10 +2,7 @@ % Please edit documentation in R/load_wbb.R \name{update_wbb_db} \alias{update_wbb_db} -\alias{wbb_db} -\alias{wbb} -\alias{wbb_pbp_db} -\title{\strong{Update or create a wehoop play-by-play database}} +\title{\strong{Build/update wehoop WBB play-by-play database}} \usage{ update_wbb_db( dbdir = ".", @@ -48,13 +45,13 @@ by play data table either for the whole wehoop era (with \code{force_rebuild = T or just for specified seasons (e.g. \code{force_rebuild = c(2019, 2020)}). Please note the following behavior: \itemize{ -\item{\code{force_rebuild = TRUE}}{: The data table with the name \code{tblname} +\item \code{force_rebuild = TRUE}: The data table with the name \code{tblname} will be removed completely and rebuilt from scratch. This is helpful when -new columns are added during the Off-Season.} -\item{\code{force_rebuild = c(2019, 2020)}}{: The data table with the name \code{tblname} +new columns are added during the Off-Season. +\item \code{force_rebuild = c(2019, 2020)}: The data table with the name \code{tblname} will be preserved and only rows from the 2019 and 2020 seasons will be deleted and re-added. This is intended to be used for ongoing seasons because -ESPN's data provider can make changes to the underlying data during the week.} +ESPN's data provider can make changes to the underlying data during the week. } The parameter \code{db_connection} is intended for advanced users who want diff --git a/man/update_wnba_db.Rd b/man/update_wnba_db.Rd index 5f27a223..81ec670d 100644 --- a/man/update_wnba_db.Rd +++ b/man/update_wnba_db.Rd @@ -2,10 +2,7 @@ % Please edit documentation in R/load_wnba.R \name{update_wnba_db} \alias{update_wnba_db} -\alias{wnba_db} -\alias{wnba} -\alias{wnba_pbp_db} -\title{\strong{Update or create a wehoop play-by-play database}} +\title{\strong{Build/update wehoop WNBA play-by-play database}} \usage{ update_wnba_db( dbdir = ".", @@ -48,13 +45,13 @@ by play data table either for the whole wehoop era (with \code{force_rebuild = T or just for specified seasons (e.g. \code{force_rebuild = c(2019, 2020)}). Please note the following behavior: \itemize{ -\item{\code{force_rebuild = TRUE}}{: The data table with the name \code{tblname} +\item \code{force_rebuild = TRUE}: The data table with the name \code{tblname} will be removed completely and rebuilt from scratch. This is helpful when -new columns are added during the Off-Season.} -\item{\code{force_rebuild = c(2019, 2020)}}{: The data table with the name \code{tblname} +new columns are added during the Off-Season. +\item \code{force_rebuild = c(2019, 2020)}: The data table with the name \code{tblname} will be preserved and only rows from the 2019 and 2020 seasons will be deleted and re-added. This is intended to be used for ongoing seasons because -ESPN's data provider can make changes to the underlying data during the week.} +ESPN's data provider can make changes to the underlying data during the week. } The parameter \code{db_connection} is intended for advanced users who want