update documentation for CRAN

R/load_mbb.R

@@ -457,10 +457,12 @@ load_mbb_games <- function() {
   return(dat)
 }
 
+#' **Update or create a hoopR MBB play-by-play database**
 #' @name update_mbb_db
-#' @aliases update_mbb_db mbb_db mbb mbb_pbp_db
+NULL
 #' @title
-#' **Update or create a hoopR play-by-play database**
+#' **Update or create a hoopR MBB play-by-play database**
+#' @rdname update_mbb_db
 #' @description `update_mbb_db()` updates or creates a database with `hoopR`
 #' play by play data of all completed and available games since 2006.
 #'
@@ -475,15 +477,15 @@ load_mbb_games <- function() {
 #' by play data table either for the whole hoopR 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

R/load_nba.R

@@ -467,10 +467,12 @@ load_nba_games <- function(){
   return(dat)
 }
 
+#' **Update or create a hoopR NBA play-by-play database**
 #' @name update_nba_db
-#' @aliases update_nba_db nba_db nba nba_pbp_db
+NULL
 #' @title
-#' **Update or create a hoopR play-by-play database**
+#' **Update or create a hoopR NBA play-by-play database**
+#' @rdname update_nba_db
 #' @description `update_nba_db()` updates or creates a database with `hoopR`
 #' play by play data of all completed and available games since 2002.
 #'
@@ -485,15 +487,15 @@ load_nba_games <- function(){
 #' by play data table either for the whole hoopR 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