Skip to content

Commit

Permalink
fix r-devel doc NOTEs and redocument
Browse files Browse the repository at this point in the history
  • Loading branch information
mrcaseb committed Aug 15, 2024
1 parent 6a12778 commit 6609682
Show file tree
Hide file tree
Showing 10 changed files with 113 additions and 66 deletions.
2 changes: 1 addition & 1 deletion R/geom_lines.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
#' @inheritDotParams ggpath::geom_mean_lines
#' @inheritDotParams ggpath::geom_median_lines
#'
#' @seealso The underlying ggplot2 geoms [`geom_hline()`] and [`geom_vline()`]
#' @seealso The underlying ggplot2 geoms [`ggplot2::geom_hline`] and [`ggplot2::geom_vline`]
#' @details These functions have been outsourced to the ggpath package.
#' See [`ggpath::geom_median_lines`] and [`ggpath::geom_mean_lines`] for details.
#'
Expand Down
10 changes: 5 additions & 5 deletions R/scale_nfl.R
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
#' values will be matched based on the names instead. Data values that don't
#' match will be given `na.value`.
#' @param guide A function used to create a guide or its name. If `NULL` (the default)
#' no guide will be plotted for this scale. See [ggplot2::guides()] for more information.
#' @param alpha Factor to modify color transparency via a call to [`scales::alpha()`].
#' no guide will be plotted for this scale. See [`ggplot2::guides`] for more information.
#' @param alpha Factor to modify color transparency via a call to [`scales::alpha`].
#' If `NA` (the default) no transparency will be applied. Can also be a vector of
#' alphas. All alpha levels must be in range `[0,1]`.
#' @name scale_nfl
Expand Down Expand Up @@ -121,7 +121,7 @@ scale_fill_nfl <- function(type = c("primary", "secondary"),
#' available as axis labels
#' @details The scale translates the NFL team abbreviations into raw image
#' html and places the html as axis labels. Because of the way ggplots are
#' constructed, it is necessary to adjust the [`theme()`] after calling this
#' constructed, it is necessary to adjust the [`ggplot2::theme`] after calling this
#' scale. This can be done by calling [`theme_x_nfl()`] or [`theme_y_nfl()`]
#' or alternatively by manually changing the relevant `axis.text` to
#' [`ggtext::element_markdown()`]. However, this will only work if an underlying
Expand All @@ -131,8 +131,8 @@ scale_fill_nfl <- function(type = c("primary", "secondary"),
#' and as width for an y-scale.
#' @name scale_axes_nfl
#' @keywords internal
#' @return A discrete ggplot2 scale created with [ggplot2::scale_x_discrete()] or
#' [ggplot2::scale_y_discrete()].
#' @return A discrete ggplot2 scale created with [`ggplot2::scale_x_discrete`] or
#' [`ggplot2::scale_y_discrete`].
#' @aliases NULL
#' @seealso [`theme_x_nfl()`], [`theme_y_nfl()`]
#' @examples
Expand Down
2 changes: 1 addition & 1 deletion R/theme_nfl.R
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
#' @name theme_nfl
#' @aliases NULL
#' @keywords internal
#' @return A ggplot2 theme created with [ggplot2::theme()].
#' @return A ggplot2 theme created with [`ggplot2::theme`].
#' @seealso [`theme_x_nfl()`], [`theme_y_nfl()`]
#' @examples
#' \donttest{
Expand Down
24 changes: 12 additions & 12 deletions man/geom_from_path.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 10 additions & 10 deletions man/geom_lines.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

34 changes: 25 additions & 9 deletions man/geom_nfl_headshots.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

38 changes: 29 additions & 9 deletions man/geom_nfl_logos.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

34 changes: 25 additions & 9 deletions man/geom_nfl_wordmarks.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 3 additions & 4 deletions man/scale_axes_nfl.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 2 additions & 6 deletions man/scale_nfl.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 6609682

Please sign in to comment.