Replace itemize with describe to fix check notes in R-devel

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: nflplotR
 Title: NFL Logo Plots in 'ggplot2'
-Version: 1.2.0.9008
+Version: 1.2.0.9009
 Authors@R: 
     person("Sebastian", "Carl", , "[email protected]", role = c("aut", "cre"))
 Description: A set of functions to visualize National Football League

NEWS.md

@@ -7,6 +7,7 @@
 * The function `geom_nfl_logos()` now plots the NFL logo, if `team_abbr == "NFL"`. (#51)
 * Added the new function `gt_nfl_cols_label()` that renders logos and wordmarks in column labels of {gt} tables. (#52)
 * The function `gt_nfl_cols_label()` now allows rendering of player headshots in column labels. Thanks Steven Patton @spatto12 for the PR. (#55)
+* Adjust lists in documentation as the next R version checks for correctly formatted lists. (#56)
 
 # nflplotR 1.2.0
 

R/geom_nfl_headshots.R

@@ -7,20 +7,20 @@
 #' @inheritParams ggplot2::geom_point
 #' @section Aesthetics:
 #' `geom_nfl_headshots()` understands the following aesthetics (required aesthetics are in bold):
-#' \itemize{
-#'   \item{**x**}{ - The x-coordinate.}
-#'   \item{**y**}{ - The y-coordinate.}
-#'   \item{**player_gsis**}{ - The players' NFL gsis id.}
-#'   \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°.}
-#'   \item{`hjust = 0.5`}{ - The horizontal adjustment relative to the given x coordinate. Must be a numerical value between 0 and 1.}
-#'   \item{`vjust = 0.5`}{ - The vertical adjustment relative to the given y coordinate. Must be a numerical value between 0 and 1.}
-#'   \item{`width = 1.0`}{ - The desired width of the image in `npc` (Normalised Parent Coordinates).
+#' \describe{
+#'   \item{**x**}{The x-coordinate.}
+#'   \item{**y**}{The y-coordinate.}
+#'   \item{**player_gsis**}{The players' NFL gsis id.}
+#'   \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°.}
+#'   \item{`hjust = 0.5`}{The horizontal adjustment relative to the given x coordinate. Must be a numerical value between 0 and 1.}
+#'   \item{`vjust = 0.5`}{The vertical adjustment relative to the given y coordinate. Must be a numerical value between 0 and 1.}
+#'   \item{`width = 1.0`}{The desired width of the image in `npc` (Normalised Parent Coordinates).
 #'                           The default value is set to 1.0 which is *big* but it is necessary
 #'                           because all used values are computed relative to the default.
 #'                           A typical size is `width = 0.075` (see below examples).}
-#'   \item{`height = 1.0`}{ - The desired height of the image in `npc` (Normalised Parent Coordinates).
+#'   \item{`height = 1.0`}{The desired height of the image in `npc` (Normalised Parent Coordinates).
 #'                            The default value is set to 1.0 which is *big* but it is necessary
 #'                            because all used values are computed relative to the default.
 #'                            A typical size is `height = 0.1` (see below examples).}

R/geom_nfl_logos.R

@@ -7,20 +7,20 @@
 #' @inheritParams ggplot2::geom_point
 #' @section Aesthetics:
 #' `geom_nfl_logos()` understands the following aesthetics (required aesthetics are in bold):
-#' \itemize{
-#'   \item{**x**}{ - The x-coordinate.}
-#'   \item{**y**}{ - The y-coordinate.}
-#'   \item{**team_abbr**}{ - The team abbreviation. Should be one of [`valid_team_names()`]. The function tries to clean team names internally by calling [`nflreadr::clean_team_abbrs()`]. Note: `"NFL"`, `"AFC"`, `"NFC"` are valid abbreviations!}
-#'   \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°.}
-#'   \item{`hjust = 0.5`}{ - The horizontal adjustment relative to the given x coordinate. Must be a numerical value between 0 and 1.}
-#'   \item{`vjust = 0.5`}{ - The vertical adjustment relative to the given y coordinate. Must be a numerical value between 0 and 1.}
-#'   \item{`width = 1.0`}{ - The desired width of the image in `npc` (Normalised Parent Coordinates).
+#' \describe{
+#'   \item{**x**}{The x-coordinate.}
+#'   \item{**y**}{The y-coordinate.}
+#'   \item{**team_abbr**}{The team abbreviation. Should be one of [`valid_team_names()`]. The function tries to clean team names internally by calling [`nflreadr::clean_team_abbrs()`]. Note: `"NFL"`, `"AFC"`, `"NFC"` are valid abbreviations!}
+#'   \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°.}
+#'   \item{`hjust = 0.5`}{The horizontal adjustment relative to the given x coordinate. Must be a numerical value between 0 and 1.}
+#'   \item{`vjust = 0.5`}{The vertical adjustment relative to the given y coordinate. Must be a numerical value between 0 and 1.}
+#'   \item{`width = 1.0`}{The desired width of the image in `npc` (Normalised Parent Coordinates).
 #'                           The default value is set to 1.0 which is *big* but it is necessary
 #'                           because all used values are computed relative to the default.
 #'                           A typical size is `width = 0.075` (see below examples).}
-#'   \item{`height = 1.0`}{ - The desired height of the image in `npc` (Normalised Parent Coordinates).
+#'   \item{`height = 1.0`}{The desired height of the image in `npc` (Normalised Parent Coordinates).
 #'                            The default value is set to 1.0 which is *big* but it is necessary
 #'                            because all used values are computed relative to the default.
 #'                            A typical size is `height = 0.1` (see below examples).}

R/geom_nfl_wordmarks.R

@@ -7,20 +7,20 @@
 #' @inheritParams ggplot2::geom_point
 #' @section Aesthetics:
 #' `geom_nfl_logos()` understands the following aesthetics (required aesthetics are in bold):
-#' \itemize{
-#'   \item{**x**}{ - The x-coordinate.}
-#'   \item{**y**}{ - The y-coordinate.}
-#'   \item{**team_abbr**}{ - The team abbreviation. Should be one of [`valid_team_names()`]. The function tries to clean team names internally by calling [`nflreadr::clean_team_abbrs()`]}
-#'   \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°.}
-#'   \item{`hjust = 0.5`}{ - The horizontal adjustment relative to the given x coordinate. Must be a numerical value between 0 and 1.}
-#'   \item{`vjust = 0.5`}{ - The vertical adjustment relative to the given y coordinate. Must be a numerical value between 0 and 1.}
-#'   \item{`width = 1.0`}{ - The desired width of the image in `npc` (Normalised Parent Coordinates).
+#' \describe{
+#'   \item{**x**}{The x-coordinate.}
+#'   \item{**y**}{The y-coordinate.}
+#'   \item{**team_abbr**}{The team abbreviation. Should be one of [`valid_team_names()`]. The function tries to clean team names internally by calling [`nflreadr::clean_team_abbrs()`]}
+#'   \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°.}
+#'   \item{`hjust = 0.5`}{The horizontal adjustment relative to the given x coordinate. Must be a numerical value between 0 and 1.}
+#'   \item{`vjust = 0.5`}{The vertical adjustment relative to the given y coordinate. Must be a numerical value between 0 and 1.}
+#'   \item{`width = 1.0`}{The desired width of the image in `npc` (Normalised Parent Coordinates).
 #'                           The default value is set to 1.0 which is *big* but it is necessary
 #'                           because all used values are computed relative to the default.
 #'                           A typical size is `width = 0.1` (see below examples).}
-#'   \item{`height = 1.0`}{ - The desired height of the image in `npc` (Normalised Parent Coordinates).
+#'   \item{`height = 1.0`}{The desired height of the image in `npc` (Normalised Parent Coordinates).
 #'                            The default value is set to 1.0 which is *big* but it is necessary
 #'                            because all used values are computed relative to the default.
 #'                            A typical size is `height = 0.1` (see below examples).}