Documentation updates

Author: camdenk

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: mlbplotR
 Type: Package
 Title: Create 'ggplot2' and 'gt' Visuals with Major League Baseball Logos
-Version: 1.1.0.9005
+Version: 1.1.0.9006
 Authors@R: 
     c(
     person(given = "Sebastian",

NEWS.md

@@ -5,6 +5,7 @@
 * Update AZ logos and team colors (v1.1.0.9003)
 * Update `gt_*` functions to be used in gt row group labels and accept unquoted column names, add `gt_fmt_milb_logo()` (v1.1.0.9004)
 * Add `gt_` and `geom_` functions for MiLB dot team logos and headshots (v1.1.0.9005)
+* Documentation updates (v1.1.0.9006)
 
 # mlbplotR 1.1.0
 

R/geom_cap_logos.R

@@ -11,11 +11,11 @@
 #'
 #' @inheritParams ggplot2::geom_point
 #' @section Aesthetics:
-#' `geom_mlb_dark_cap_logos()` and `geom_mlb_light_cap_logos()` understand the following aesthetics (required aesthetics are in bold):
+#' `geom_mlb_dark_cap_logos()` and `geom_mlb_light_cap_logos()` understand the following aesthetics:
 #' \describe{
-#'   \item{**x**}{ - The x-coordinate.}
-#'   \item{**y**}{ - The y-coordinate.}
-#'   \item{**team_abbr**}{ - The team abbreviation. Need to use Savant's abbreviation.}
+#'   \item{`x`}{ - The x-coordinate. Required.}
+#'   \item{`y`}{ - The y-coordinate. Required.}
+#'   \item{`team_abbr`}{ - The team abbreviation. Need to use Savant's abbreviation. Required.}
 #'   \item{`alpha = NULL`}{ - The alpha channel, i.e. transparency level, as a numerical value between 0 and 1.}
 #'   \item{`colour = NULL`}{ - The image will be colourized with this colour. Use the special character `"b/w"` to set it to black and white. For more information on valid colour names in ggplot2 see <https://ggplot2.tidyverse.org/articles/ggplot2-specs.html?q=colour#colour-and-fill>}
 #'   \item{`angle = 0`}{ - The angle of the image as a numerical value between 0° and 360°.}

R/geom_from_path.R

@@ -5,11 +5,11 @@
 #'
 #' @inheritParams ggplot2::geom_point
 #' @section Aesthetics:
-#' `geom_mlb_logos()` understands the following aesthetics (required aesthetics are in bold):
+#' `geom_mlb_logos()` understands the following aesthetics:
 #' \describe{
-#'   \item{**x**}{ - The x-coordinate.}
-#'   \item{**y**}{ - The y-coordinate.}
-#'   \item{**path**}{ - a file path, url, raster object or bitmap array. See [`magick::image_read()`] for further information.}
+#'   \item{`x`}{ - The x-coordinate. Required.}
+#'   \item{`y`}{ - The y-coordinate. Required.}
+#'   \item{`path`}{ - a file path, url, raster object or bitmap array. See [`magick::image_read()`] for further information. Required.}
 #'   \item{`alpha = NULL`}{ - The alpha channel, i.e. transparency level, as a numerical value between 0 and 1.}
 #'   \item{`colour = NULL`}{ - The image will be colorized with this colour. Use the special character `"b/w"` to set it to black and white. For more information on valid colour names in ggplot2 see <https://ggplot2.tidyverse.org/articles/ggplot2-specs.html?q=colour#colour-and-fill>}
 #'   \item{`angle = 0`}{ - The angle of the image as a numerical value between 0° and 360°.}

R/geom_lines.R

@@ -13,10 +13,10 @@
 #'   the default plot specification.
 #' @section Aesthetics:
 #' `geom_median_lines()` and `geom_mean_lines()` understand the following
-#' aesthetics (at least one of the bold aesthetics is required):
+#' aesthetics (at least one of `v_var` and `h_var` are required):
 #' \describe{
-#'   \item{**v_var**}{ - The variable for which to compute the median/mean that is drawn as vertical line.}
-#'   \item{**h_var**}{ - The variable for which to compute the median/mean that is drawn as horizontal line.}
+#'   \item{`v_var`}{ - The variable for which to compute the median/mean that is drawn as vertical line.}
+#'   \item{`h_var`}{ - The variable for which to compute the median/mean that is drawn as horizontal line.}
 #'   \item{`alpha = NA`}{ - The alpha channel, i.e. transparency level, as a numerical value between 0 and 1.}
 #'   \item{`color = "black"`}{ - The color of the drawn lines.}
 #'   \item{`linetype = 2`}{ - The linetype of the drawn lines.}

R/geom_milb_logos.R

@@ -8,11 +8,11 @@
 #'
 #' @inheritParams ggplot2::geom_point
 #' @section Aesthetics:
-#' `geom_milb_logos()`, `geom_milb_light_cap_logos()`, `geom_milb_dot_logos()` understand the following aesthetics (required aesthetics are in bold):
+#' `geom_milb_logos()`, `geom_milb_light_cap_logos()`, `geom_milb_dot_logos()` understand the following aesthetics:
 #' \describe{
-#'   \item{**x**}{ - The x-coordinate.}
-#'   \item{**y**}{ - The y-coordinate.}
-#'   \item{**team_name**}{ - The team name. Need to use the full team name.}
+#'   \item{`x`}{ - The x-coordinate. Required.}
+#'   \item{`y`}{ - The y-coordinate. Required.}
+#'   \item{`team_name`}{ - The team name. Need to use the full team name. Required.}
 #'   \item{`alpha = NULL`}{ - The alpha channel, i.e. transparency level, as a numerical value between 0 and 1.}
 #'   \item{`colour = NULL`}{ - The image will be colourized with this colour. Use the special character `"b/w"` to set it to black and white. For more information on valid colour names in ggplot2 see <https://ggplot2.tidyverse.org/articles/ggplot2-specs.html?q=colour#colour-and-fill>}
 #'   \item{`angle = 0`}{ - The angle of the image as a numerical value between 0° and 360°.}

R/geom_mlb_headshots.R

@@ -8,11 +8,11 @@
 #'
 #' @inheritParams ggplot2::geom_point
 #' @section Aesthetics:
-#' `geom_mlb_headshots()`, `geom_mlb_dot_headshots()`, `geom_milb_dot_headshots()`, understand the following aesthetics (required aesthetics are in bold):
+#' `geom_mlb_headshots()`, `geom_mlb_dot_headshots()`, `geom_milb_dot_headshots()`, understand the following aesthetics:
 #' \describe{
-#'   \item{**x**}{ - The x-coordinate.}
-#'   \item{**y**}{ - The y-coordinate.}
-#'   \item{**player_id**}{ - The players' MLB (Baseball Savant) id.}
+#'   \item{`x`}{ - The x-coordinate. Required.}
+#'   \item{`y`}{ - The y-coordinate. Required.}
+#'   \item{`player_id`}{ - The players' MLBAM (Baseball Savant) id. Required.}
 #'   \item{`na_headshot_to_logo = TRUE`}{ - Should NA/non-matches return the MLB logo
 #'                                          instead of a grayed out blank headshot? Only used with `geom_mlb_headshots()`. Defaults to `TRUE`}
 #'   \item{`alpha = NULL`}{ - The alpha channel, i.e. transparency level, as a numerical value between 0 and 1.}

R/geom_mlb_logos.R

@@ -10,11 +10,11 @@
 #'
 #' @inheritParams ggplot2::geom_point
 #' @section Aesthetics:
-#' `geom_mlb_logos()`, `geom_mlb_scoreboard_logos()`, and `geom_mlb_dot_logos()` understand the following aesthetics (required aesthetics are in bold):
+#' `geom_mlb_logos()`, `geom_mlb_scoreboard_logos()`, and `geom_mlb_dot_logos()` understand the following aesthetics:
 #' \describe{
-#'   \item{**x**}{ - The x-coordinate.}
-#'   \item{**y**}{ - The y-coordinate.}
-#'   \item{**team_abbr**}{ - The team abbreviation. Need to use Savant's abbreviation.}
+#'   \item{`x`}{ - The x-coordinate. Required.}
+#'   \item{`y`}{ - The y-coordinate. Required.}
+#'   \item{`team_abbr`}{ - The team abbreviation. Need to use Savant's abbreviation. Required.}
 #'   \item{`alpha = NULL`}{ - The alpha channel, i.e. transparency level, as a numerical value between 0 and 1.}
 #'   \item{`colour = NULL`}{ - The image will be colourized with this colour. Use the special character `"b/w"` to set it to black and white. For more information on valid colour names in ggplot2 see <https://ggplot2.tidyverse.org/articles/ggplot2-specs.html?q=colour#colour-and-fill>}
 #'   \item{`angle = 0`}{ - The angle of the image as a numerical value between 0° and 360°.}

R/gt_helpers.R

@@ -436,7 +436,7 @@ gt_fmt_milb_dot_headshot <- function(gt_object,
 #' Replace Team Abbreviations/Player IDs With Images In Column Labels
 #'
 #' @description
-#' `gt_column_example` takes in a value of a team abbreviation or player id and
+#' `gt_mlb_column_labels` takes in a value of a team abbreviation or player id and
 #' converts the designated column to the corresponding image.
 #'
 #' @param value What team abbreviation/player id should be replaced with an image?