From 7882a73db528393a9f18554df969d0709a172f7e Mon Sep 17 00:00:00 2001 From: mrcaseb Date: Sun, 4 Feb 2024 13:44:27 +0100 Subject: [PATCH] format as code --- R/geom_nfl_headshots.R | 6 +++--- R/geom_nfl_logos.R | 6 +++--- R/geom_nfl_wordmarks.R | 6 +++--- man/geom_from_path.Rd | 6 +++--- man/geom_lines.Rd | 4 ++-- man/geom_nfl_headshots.Rd | 6 +++--- man/geom_nfl_logos.Rd | 6 +++--- man/geom_nfl_wordmarks.Rd | 6 +++--- 8 files changed, 23 insertions(+), 23 deletions(-) diff --git a/R/geom_nfl_headshots.R b/R/geom_nfl_headshots.R index e944fd9..52175e3 100644 --- a/R/geom_nfl_headshots.R +++ b/R/geom_nfl_headshots.R @@ -8,9 +8,9 @@ #' @section Aesthetics: #' `geom_nfl_headshots()` understands the following aesthetics (required aesthetics are in bold): #' \describe{ -#' \item{**x**}{The x-coordinate.} -#' \item{**y**}{The y-coordinate.} -#' \item{**player_gsis**}{The players' NFL gsis id.} +#' \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 } #' \item{`angle = 0`}{The angle of the image as a numerical value between 0° and 360°.} diff --git a/R/geom_nfl_logos.R b/R/geom_nfl_logos.R index 6acdc28..1b075bc 100644 --- a/R/geom_nfl_logos.R +++ b/R/geom_nfl_logos.R @@ -8,9 +8,9 @@ #' @section Aesthetics: #' `geom_nfl_logos()` understands the following aesthetics (required aesthetics are in bold): #' \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{**`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 } #' \item{`angle = 0`}{The angle of the image as a numerical value between 0° and 360°.} diff --git a/R/geom_nfl_wordmarks.R b/R/geom_nfl_wordmarks.R index 095aafe..726fdab 100644 --- a/R/geom_nfl_wordmarks.R +++ b/R/geom_nfl_wordmarks.R @@ -8,9 +8,9 @@ #' @section Aesthetics: #' `geom_nfl_logos()` understands the following aesthetics (required aesthetics are in bold): #' \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{**`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 } #' \item{`angle = 0`}{The angle of the image as a numerical value between 0° and 360°.} diff --git a/man/geom_from_path.Rd b/man/geom_from_path.Rd index 33017aa..fd911b5 100644 --- a/man/geom_from_path.Rd +++ b/man/geom_from_path.Rd @@ -68,9 +68,9 @@ See \code{\link[ggpath:geom_from_path]{ggpath::geom_from_path}} for details. \code{geom_from_path()} understands the following aesthetics (required aesthetics are in bold): \describe{ -\item{\strong{x}}{The x-coordinate.} -\item{\strong{y}}{The y-coordinate.} -\item{\strong{path}}{a file path, url, raster object or bitmap array. See \code{\link[magick:editing]{magick::image_read()}} for further information.} +\item{\strong{\code{x}}}{The x-coordinate.} +\item{\strong{\code{y}}}{The y-coordinate.} +\item{\strong{\code{path}}}{a file path, url, raster object or bitmap array. See \code{\link[magick:editing]{magick::image_read()}} for further information.} \item{\code{alpha = NULL}}{The alpha channel, i.e. transparency level, as a numerical value between 0 and 1.} \item{\code{colour = NULL}}{The image will be colorized with this colour. Use the special character \code{"b/w"} to set it to black and white. For more information on valid colour names in ggplot2 see \url{https://ggplot2.tidyverse.org/articles/ggplot2-specs.html?q=colour#colour-and-fill}} \item{\code{angle = 0}}{The angle of the image as a numerical value between 0° and 360°.} diff --git a/man/geom_lines.Rd b/man/geom_lines.Rd index 38a2580..b795151 100644 --- a/man/geom_lines.Rd +++ b/man/geom_lines.Rd @@ -61,8 +61,8 @@ See \code{\link[ggpath:geom_lines]{ggpath::geom_median_lines}} and \code{\link[g \code{geom_median_lines()} and \code{geom_mean_lines()} understand the following aesthetics (at least one of the bold aesthetics is required): \describe{ -\item{\strong{x0}}{The variable for which to compute the median/mean that is drawn as vertical line.} -\item{\strong{y0}}{The variable for which to compute the median/mean that is drawn as horizontal line.} +\item{\strong{\code{x0}}}{The variable for which to compute the median/mean that is drawn as vertical line.} +\item{\strong{\code{y0}}}{The variable for which to compute the median/mean that is drawn as horizontal line.} \item{\code{alpha = NA}}{The alpha channel, i.e. transparency level, as a numerical value between 0 and 1.} \item{\code{color = "red"}}{The color of the drawn lines.} \item{\code{linetype = 2}}{The linetype of the drawn lines.} diff --git a/man/geom_nfl_headshots.Rd b/man/geom_nfl_headshots.Rd index 9f7871e..2229bd4 100644 --- a/man/geom_nfl_headshots.Rd +++ b/man/geom_nfl_headshots.Rd @@ -77,9 +77,9 @@ player gsis id. \code{geom_nfl_headshots()} understands the following aesthetics (required aesthetics are in bold): \describe{ -\item{\strong{x}}{The x-coordinate.} -\item{\strong{y}}{The y-coordinate.} -\item{\strong{player_gsis}}{The players' NFL gsis id.} +\item{\strong{\code{x}}}{The x-coordinate.} +\item{\strong{\code{y}}}{The y-coordinate.} +\item{\strong{\code{player_gsis}}}{The players' NFL gsis id.} \item{\code{alpha = NULL}}{The alpha channel, i.e. transparency level, as a numerical value between 0 and 1.} \item{\code{colour = NULL}}{The image will be colorized with this colour. Use the special character \code{"b/w"} to set it to black and white. For more information on valid colour names in ggplot2 see \url{https://ggplot2.tidyverse.org/articles/ggplot2-specs.html?q=colour#colour-and-fill}} \item{\code{angle = 0}}{The angle of the image as a numerical value between 0° and 360°.} diff --git a/man/geom_nfl_logos.Rd b/man/geom_nfl_logos.Rd index 9c80c08..5beae27 100644 --- a/man/geom_nfl_logos.Rd +++ b/man/geom_nfl_logos.Rd @@ -77,9 +77,9 @@ team abbreviation. The latter can be checked with \code{\link[=valid_team_names] \code{geom_nfl_logos()} understands the following aesthetics (required aesthetics are in bold): \describe{ -\item{\strong{x}}{The x-coordinate.} -\item{\strong{y}}{The y-coordinate.} -\item{\strong{team_abbr}}{The team abbreviation. Should be one of \code{\link[=valid_team_names]{valid_team_names()}}. The function tries to clean team names internally by calling \code{\link[nflreadr:clean_team_abbrs]{nflreadr::clean_team_abbrs()}}. Note: \code{"NFL"}, \code{"AFC"}, \code{"NFC"} are valid abbreviations!} +\item{\strong{\code{x}}}{The x-coordinate.} +\item{\strong{\code{y}}}{The y-coordinate.} +\item{\strong{\code{team_abbr}}}{The team abbreviation. Should be one of \code{\link[=valid_team_names]{valid_team_names()}}. The function tries to clean team names internally by calling \code{\link[nflreadr:clean_team_abbrs]{nflreadr::clean_team_abbrs()}}. Note: \code{"NFL"}, \code{"AFC"}, \code{"NFC"} are valid abbreviations!} \item{\code{alpha = NULL}}{The alpha channel, i.e. transparency level, as a numerical value between 0 and 1.} \item{\code{colour = NULL}}{The image will be colorized with this colour. Use the special character \code{"b/w"} to set it to black and white. For more information on valid colour names in ggplot2 see \url{https://ggplot2.tidyverse.org/articles/ggplot2-specs.html?q=colour#colour-and-fill}} \item{\code{angle = 0}}{The angle of the image as a numerical value between 0° and 360°.} diff --git a/man/geom_nfl_wordmarks.Rd b/man/geom_nfl_wordmarks.Rd index 2aee184..6c368c3 100644 --- a/man/geom_nfl_wordmarks.Rd +++ b/man/geom_nfl_wordmarks.Rd @@ -77,9 +77,9 @@ team abbreviation. The latter can be checked with \code{\link[=valid_team_names] \code{geom_nfl_logos()} understands the following aesthetics (required aesthetics are in bold): \describe{ -\item{\strong{x}}{The x-coordinate.} -\item{\strong{y}}{The y-coordinate.} -\item{\strong{team_abbr}}{The team abbreviation. Should be one of \code{\link[=valid_team_names]{valid_team_names()}}. The function tries to clean team names internally by calling \code{\link[nflreadr:clean_team_abbrs]{nflreadr::clean_team_abbrs()}}} +\item{\strong{\code{x}}}{The x-coordinate.} +\item{\strong{\code{y}}}{The y-coordinate.} +\item{\strong{\code{team_abbr}}}{The team abbreviation. Should be one of \code{\link[=valid_team_names]{valid_team_names()}}. The function tries to clean team names internally by calling \code{\link[nflreadr:clean_team_abbrs]{nflreadr::clean_team_abbrs()}}} \item{\code{alpha = NULL}}{The alpha channel, i.e. transparency level, as a numerical value between 0 and 1.} \item{\code{colour = NULL}}{The image will be colorized with this colour. Use the special character \code{"b/w"} to set it to black and white. For more information on valid colour names in ggplot2 see \url{https://ggplot2.tidyverse.org/articles/ggplot2-specs.html?q=colour#colour-and-fill}} \item{\code{angle = 0}}{The angle of the image as a numerical value between 0° and 360°.}