Merge pull request #643 from olivroy/docs

Minor edits to documentation

R/gg_area.R

@@ -1,6 +1,6 @@
 #' @title Area ggplot
 #'
-#' @description Create an area ggplot with a wrapper around ggplot() + geom_area.
+#' @description Create an area ggplot with a wrapper around `ggplot()` + [geom_area()][ggplot2::geom_area()].
 #'
 #' @inheritParams gg_blanket
 #'

R/gg_bar.R

@@ -1,6 +1,6 @@
 #' @title Bar ggplot
 #'
-#' @description Create a bar ggplot with a wrapper around ggplot() + geom_bar.
+#' @description Create a bar ggplot with a wrapper around `ggplot()` + [geom_bar()][ggplot2::geom_bar()].
 #'
 #' @inheritParams gg_blanket
 #'

R/gg_bin_2d.R

@@ -1,6 +1,6 @@
 #' @title Bin_2d ggplot
 #'
-#' @description Create a bin2d ggplot with a wrapper around ggplot() + geom_bin_2d.
+#' @description Create a bin2d ggplot with a wrapper around `ggplot()` + [geom_bin_2d()][ggplot2::geom_bin_2d()].
 #'
 #' @inheritParams gg_blanket
 #'

R/gg_blanket.R

@@ -1,96 +1,85 @@
 #' @title Blanket ggplot with geom flexibility
 #'
-#' @description Create a blanket ggplot with a wrapper around ggplot() + layer() with geom_blank defaults.
+#' @description Create a blanket ggplot with a wrapper around `ggplot()` + `layer()` with [geom_blank()][ggplot2::geom_blank()] defaults.
 #'
 #' @param data A data frame or tibble.
-#' @param ... Other arguments passed to within a params list in the layer function.
+#' @param ... Other arguments passed to within a `params` list in `layer()`.
 #' @param geom A geometric object to display the data. A snakecase character string of a ggproto Geom subclass object minus the Geom prefix (e.g. "point").
 #' @param stat A statistical transformation to use on the data. A snakecase character string of a ggproto Stat subclass object minus the Stat prefix (e.g. "identity").
-#' @param position A position adjustment. A snakecase character string of a ggproto Position subclass object minus the Position prefix (e.g. "identity"), or a position_* function that outputs a ggproto Position subclass object (e.g. ggplot2::position_identity()).
-#' @param coord A coordinate system. A coord_* function that outputs a constructed ggproto Coord subclass object (e.g. ggplot2::coord_cartesian()).
-#' @param theme A ggplot2 theme (e.g. light_mode_b(), dark_mode_rt() or ggplot2::theme_grey()).
-#' @param x Unquoted x aesthetic variable.
-#' @param xmin Unquoted xmin aesthetic variable.
-#' @param xmax Unquoted xmax aesthetic variable.
-#' @param xend Unquoted xend aesthetic variable.
-#' @param y Unquoted y aesthetic variable.
-#' @param ymin Unquoted ymin aesthetic variable.
-#' @param ymax Unquoted ymax aesthetic variable.
-#' @param yend Unquoted yend aesthetic variable.
-#' @param z Unquoted z aesthetic variable.
-#' @param col Unquoted col and fill aesthetic variable.
-#' @param alpha Unquoted alpha aesthetic variable.
-#' @param facet Unquoted facet aesthetic variable.
+#' @param position A position adjustment. A snakecase character string of a ggproto Position subclass object minus the Position prefix (e.g. "identity"), or a `position_*()` function that outputs a ggproto Position subclass object (e.g. `ggplot2::position_identity()`).
+#' @param coord A coordinate system. A coord_* function that outputs a constructed ggproto Coord subclass object (e.g. [ggplot2::coord_cartesian()]).
+#' @param theme A ggplot2 theme (e.g. [light_mode_b()], [dark_mode_rt()] or [ggplot2::theme_grey()]).
+#' @param x Unquoted `x` aesthetic variable.
+#' @param xmin Unquoted `xmin` aesthetic variable.
+#' @param xmax Unquoted `xmax` aesthetic variable.
+#' @param xend Unquoted `xend` aesthetic variable.
+#' @param y Unquoted `y` aesthetic variable.
+#' @param ymin Unquoted `ymin` aesthetic variable.
+#' @param ymax Unquoted `ymax` aesthetic variable.
+#' @param yend Unquoted `yend` aesthetic variable.
+#' @param z Unquoted `z` aesthetic variable.
+#' @param col Unquoted `col` and `fill` aesthetic variable.
+#' @param alpha Unquoted `alpha` aesthetic variable.
+#' @param facet Unquoted `facet` aesthetic variable.
 #' @param facet2 Unquoted second facet variable.
-#' @param group Unquoted group aesthetic variable.
-#' @param subgroup Unquoted subgroup aesthetic variable.
-#' @param label Unquoted label aesthetic variable.
-#' @param text Unquoted text aesthetic variable.
-#' @param sample Unquoted sample aesthetic variable.
-#' @param mapping Set of additional aesthetic mappings within the ggplot2::aes function for non-supported aesthetics (e.g. shape, linetype, linewidth, or size) or for delayed evaluation.
-#' @param x_breaks A scales::breaks_* function (e.g. scales::breaks_pretty()), or a vector of breaks.
-#' @param x_expand Padding to the limits with the ggplot2::expansion function, or a vector of length 2 (e.g. c(0, 0)).
-#' @param x_expand_limits For a continuous x variable, any values that the limits should encompass (e.g. 0).
-#' @param x_gridlines TRUE or FALSE for vertical x gridlines. NULL guesses based on the classes of the x and y.
-#' @param x_labels A function that takes the breaks as inputs (e.g. \(x) stingr::str_to_sentence(x) or scales::label_comma()), or a vector of labels.
-#' @param x_limits A vector of length 2 to determine the limits of the axis.
-#' @param x_oob For a continuous x variable, a scales::oob_* function of how to handle values outside of limits (e.g. scales::oob_keep). Defaults to scales::oob_keep.
-#' @param x_sec_axis A secondary axis using the ggplot2::sec_axis or ggplot2::dup_axis function.
-#' @param x_title Axis title string. Use "" for no title.
-#' @param x_transform For a numeric x variable, a transformation object (e.g. scales::transform_log10()) or character string of this minus the transform_ prefix (e.g. "log10").
-#' @param y_breaks A scales::breaks_* function (e.g. scales::breaks_pretty()), or a vector of breaks.
-#' @param y_expand Padding to the limits with the ggplot2::expansion function, or a vector of length 2 (e.g. c(0, 0)).
-#' @param y_expand_limits For a continuous y variable, any values that the limits should encompass (e.g. 0).
-#' @param y_gridlines TRUE or FALSE of horizontal y gridlines. NULL guesses based on the classes of the x and y.
-#' @param y_labels A function that takes the breaks as inputs (e.g. \(x) stingr::str_to_sentence(x) or scales::label_comma()), or a vector of labels.
-#' @param y_limits A vector of length 2 to determine the limits of the axis.
-#' @param y_oob For a continuous y variable, a scales::oob_* function of how to handle values outside of limits (e.g. scales::oob_keep). Defaults to scales::oob_keep.
-#' @param y_sec_axis A secondary axis using the ggplot2::sec_axis or ggplot2::dup_axis function.
-#' @param y_title Axis title string. Use "" for no title.
-#' @param y_transform For a numeric y variable, a transformation object (e.g. scales::transform_log10()) or character string of this minus the transform_ prefix (e.g. "log10").
-#' @param col_breaks A scales::breaks_* function (e.g. scales::breaks_pretty()), or a vector of breaks.
+#' @param group Unquoted `group` aesthetic variable.
+#' @param subgroup Unquoted `subgroup` aesthetic variable.
+#' @param label Unquoted `label` aesthetic variable.
+#' @param text Unquoted `text` aesthetic variable.
+#' @param sample Unquoted `sample` aesthetic variable.
+#' @param mapping Set of additional aesthetic mappings within `ggplot2::aes()` for non-supported aesthetics (e.g. `shape`, `linetype`, `linewidth`, or `size`) or for delayed evaluation.
+#' @param x_breaks,y_breaks A `scales::breaks_*` function (e.g. [scales::breaks_pretty()]), or a vector of breaks.
+#' @param x_expand,y_expand Padding to the limits with the `ggplot2::expansion()` function, or a vector of length 2 (e.g. `c(0, 0)`).
+#' @param x_expand_limits,y_expand_limits For a continuous variable, any values that the limits should encompass (e.g. 0).
+#' @param x_gridlines `TRUE` or `FALSE` for vertical `x` gridlines. `NULL` guesses based on the classes of the x and y.
+#' @param x_labels,y_labels A function that takes the breaks as inputs (e.g. `\(x) stringr::str_to_sentence(x)` or [scales::label_comma()]), or a vector of labels.
+#' @param x_limits,y_limits A vector of length 2 to determine the limits of the axis.
+#' @param x_oob,y_oob For a continuous `x` variable, a `scales::oob_*` function of how to handle values outside of limits (e.g. `scales::oob_keep`). Defaults to `scales::oob_keep`.
+#' @param x_sec_axis,y_sec_axis A secondary axis using `ggplot2::sec_axis()` or `ggplot2::dup_axis()`.
+#' @param x_title,y_title Axis title string. Use `""` for no title.
+#' @param x_transform,y_transform For a numeric variable, a transformation object (e.g. `scales::transform_log10()`) or character string of this minus the `transform_` prefix (e.g. "log10").
+#' @param y_gridlines `TRUE` or `FALSE` of horizontal `y` gridlines. `NULL` guesses based on the classes of the `x` and `y`.
+#' @param col_breaks A `scales::breaks_*` function (e.g. `scales::breaks_pretty()`), or a vector of breaks.
 #' @param col_continuous_type For a continuous variable, whether to colour as a "gradient" or in "steps". Defaults to "gradient".
-#' @param col_expand Padding to the limits with the ggplot2::expansion function, or a vector of length 2 (e.g. c(0, 0)).
+#' @param col_expand Padding to the limits with `ggplot2::expansion()`, or a vector of length 2 (e.g. `c(0, 0)`).
 #' @param col_expand_limits For a continuous variable, any values that the limits should encompass (e.g. 0).
-#' @param col_labels A function that takes the breaks as inputs (e.g. \(x) stingr::str_to_sentence(x) or scales::label_comma()), or a vector of labels.
-#' @param col_legend_ncol The number of columns for the legend elements.
-#' @param col_legend_nrow The number of rows for the legend elements.
-#' @param col_legend_rev Reverse the elements of the legend. Defaults to FALSE.
+#' @param col_labels A function that takes the breaks as inputs (e.g. `\(x) stringr::str_to_sentence(x)` or `scales::label_comma()`), or a vector of labels.
+#' @param col_legend_ncol,col_legend_nrow The number of columns and rows for the legend elements.
+#' @param col_legend_rev Reverse the elements of the legend. Defaults to `FALSE`.
 #' @param col_limits A vector to determine the limits of the scale.
-#' @param col_oob For a continuous variable, a scales::oob_* function of how to handle values outside of limits (e.g. scales::oob_keep). Defaults to scales::oob_keep.
+#' @param col_oob For a continuous variable, a `scales::oob_*` function of how to handle values outside of limits (e.g. `scales::oob_keep`). Defaults to `scales::oob_keep`.
 #' @param col_pal colours to use. A character vector of hex codes (or names).
-#' @param col_pal_na colour to use for NA values. A character vector of a hex code (or name).
-#' @param col_rescale For a continuous variable, a scales::rescale function.
+#' @param col_pal_na colour to use for `NA` values. A character vector of a hex code (or name).
+#' @param col_rescale For a continuous variable, a `scales::rescale` function.
 #' @param col_title Legend title string. Use "" for no title.
-#' @param col_transform For a numeric variable, a transformation object (e.g. scales::transform_log10()) or character string of this minus the transform_ prefix (e.g. "log10").
-#' @param alpha_breaks A scales::breaks_* function (e.g. scales::breaks_pretty()), or a vector of breaks.
-#' @param alpha_expand Padding to the limits with the ggplot2::expansion function, or a vector of length 2 (e.g. c(0, 0)).
+#' @param col_transform For a numeric variable, a transformation object (e.g. scales::transform_log10()) or character string of this minus the `transform_` prefix (e.g. "log10").
+#' @param alpha_breaks A `scales::breaks_*` function (e.g. `scales::breaks_pretty()`), or a vector of breaks.
+#' @param alpha_expand Padding to the limits with the ggplot2::expansion function, or a vector of length 2 (e.g. `c(0, 0)`).
 #' @param alpha_expand_limits For a continuous variable, any values that the limits should encompass (e.g. 0).
-#' @param alpha_labels A function that takes the breaks as inputs (e.g. \(x) stingr::str_to_sentence(x) or scales::label_comma()), or a vector of labels.
-#' @param alpha_legend_ncol The number of columns for the legend elements.
-#' @param alpha_legend_nrow The number of rows for the legend elements.
-#' @param alpha_legend_rev Reverse the elements of the legend. Defaults to FALSE.
+#' @param alpha_labels A function that takes the breaks as inputs (e.g. `\(x) stringr::str_to_sentence(x)` or `scales::label_comma()`), or a vector of labels.
+#' @param alpha_legend_ncol,alpha_legend_nrow The number of columns and rows for the legend elements.
+#' @param alpha_legend_rev Reverse the elements of the legend. Defaults to `FALSE`.
 #' @param alpha_limits A vector to determine the limits of the scale.
-#' @param alpha_oob For a continuous variable, a scales::oob_* function of how to handle values outside of limits (e.g. scales::oob_keep). Defaults to scales::oob_keep.
+#' @param alpha_oob For a continuous variable, a `scales::oob_*` function of how to handle values outside of limits (e.g. `scales::oob_keep`). Defaults to `scales::oob_keep`.
 #' @param alpha_pal Alpha values to use as a numeric vector. For a continuous variable, a range is only needed.
-#' @param alpha_pal_na Alpha value to use for the NA value.
-#' @param alpha_title Legend title string. Use "" for no title.
-#' @param alpha_transform For a numeric variable, a transformation object (e.g. scales::transform_log10()) or character string of this minus the transform_ prefix (e.g. "log10").
+#' @param alpha_pal_na Alpha value to use for the `NA` value.
+#' @param alpha_title Legend title string. Use `""` for no title.
+#' @param alpha_transform For a numeric variable, a transformation object (e.g. `scales::transform_log10()`) or character string of this minus the transform_ prefix (e.g. "log10").
 #' @param facet_axes Whether to add interior axes and ticks with "margins", "all", "all_x", or "all_y".
 #' @param facet_axis_labels Whether to add interior axis labels with "margins", "all", "all_x", or "all_y".
-#' @param facet_labels A function that takes the breaks as inputs (e.g. \(x) stingr::str_to_sentence(x) or scales::label_comma()), or a named vector of labels (e.g. c("value1" = "label1", ...)).
+#' @param facet_labels A function that takes the breaks as inputs (e.g. `\(x) stringr::str_to_sentence(x)` or `scales::label_comma()`), or a named vector of labels (e.g. c("value1" = "label1", ...)).
 #' @param facet_labels_position When the facet layout is "wrap", the position of the facet labels. Either "top", "right", "bottom" or "left".
 #' @param facet_labels_switch When the facet layout is "grid", whether to switch the facet labels to the opposite side of the plot. Either "x", "y" or "both".
-#' @param facet_layout Whether the layout is to be "wrap" or "grid". If NULL and a single facet (or facet2) argument is provided, then defaults to "wrap". If NULL and both facet and facet2 arguments are provided, defaults to "grid".
+#' @param facet_layout Whether the layout is to be "wrap" or "grid". If `NULL` and a single `facet` (or `facet2`) argument is provided, then defaults to "wrap". If `NULL` and both facet and facet2 arguments are provided, defaults to "grid".
 #' @param facet_ncol The number of columns of facets. Only applies to a facet layout of "wrap".
 #' @param facet_nrow The number of rows of facets. Only applies to a facet layout of "wrap".
 #' @param facet_scales Whether facet scales should be "fixed" across facets, "free" in both directions, or free in just one direction (i.e. "free_x" or "free_y"). Defaults to "fixed".
 #' @param facet_space When the facet layout is "grid" and facet scales are not "fixed", whether facet space should be "fixed" across facets, "free" to be proportional in both directions, or free to be proportional in just one direction (i.e. "free_x" or "free_y"). Defaults to "fixed".
 #' @param title Title string.
 #' @param subtitle Subtitle string.
 #' @param caption Caption title string.
-#' @param titles A function to format unspecified titles. Defaults to snakecase::to_sentence_case.
-#' @param flipped TRUE or FALSE or whether the plot is flipped. This affects the defaults of positional scale and gridlines.
+#' @param titles A function to format unspecified titles. Defaults to `snakecase::to_sentence_case`.
+#' @param flipped `TRUE` or `FALSE` or whether the plot is flipped. This affects the defaults of positional scale and gridlines.
 #'
 #' @return A ggplot object.
 #' @export

R/gg_boxplot.R

@@ -1,6 +1,6 @@
 #' @title Boxplot ggplot
 #'
-#' @description Create a boxplot ggplot with a wrapper around ggplot() + geom_boxplot.
+#' @description Create a boxplot ggplot with a wrapper around `ggplot()` + [geom_boxplot()][ggplot2::geom_boxplot()].
 #'
 #' @inheritParams gg_blanket
 #'

R/gg_col.R

@@ -1,6 +1,6 @@
 #' @title Col ggplot
 #'
-#' @description Create a col ggplot with a wrapper around ggplot() + geom_col.
+#' @description Create a col ggplot with a wrapper around `ggplot()` + [geom_col()][ggplot2::geom_col()].
 #'
 #' @inheritParams gg_blanket
 #'

R/gg_contour.R

@@ -1,6 +1,6 @@
 #' @title Contour ggplot
 #'
-#' @description Create a contour ggplot with a wrapper around ggplot() + geom_contour.
+#' @description Create a contour ggplot with a wrapper around `ggplot()` + [geom_contour()][ggplot2::geom_contour()].
 #'
 #' @inheritParams gg_blanket
 #'

R/gg_contour_filled.R

@@ -1,6 +1,6 @@
 #' @title Contour_filled ggplot
 #'
-#' @description Create a contour_filled ggplot with a wrapper around ggplot() + geom_contour_filled.
+#' @description Create a contour_filled ggplot with a wrapper around `ggplot()` + [geom_contour_filled()][ggplot2::geom_contour_filled()].
 #'
 #' @inheritParams gg_blanket
 #'

R/gg_crossbar.R

@@ -1,6 +1,6 @@
 #' @title Crossbar ggplot
 #'
-#' @description Create a crossbar ggplot with a wrapper around ggplot() + geom_crossbar.
+#' @description Create a crossbar ggplot with a wrapper around `ggplot()` + [geom_crossbar()][ggplot2::geom_crossbar()].
 #'
 #' @inheritParams gg_blanket
 #'

R/gg_density.R

@@ -1,6 +1,6 @@
 #' @title Density ggplot
 #'
-#' @description Create a density ggplot with a wrapper around ggplot() + geom_density.
+#' @description Create a density ggplot with a wrapper around `ggplot()` + [geom_density()][ggplot2::geom_density()].
 #'
 #' @inheritParams gg_blanket
 #'

R/gg_density_2d.R

@@ -1,6 +1,6 @@
 #' @title Density_2d ggplot
 #'
-#' @description Create a density_2d ggplot with a wrapper around ggplot() + geom_density_2d.
+#' @description Create a density_2d ggplot with a wrapper around `ggplot()` + [geom_density_2d()][ggplot2::geom_density_2d()].
 #'
 #' @inheritParams gg_blanket
 #'

R/gg_density_2d_filled.R

@@ -1,6 +1,6 @@
 #' @title Density_2d_filled ggplot
 #'
-#' @description Create a density_2d_filled ggplot with a wrapper around ggplot() + geom_density_2d_filled.
+#' @description Create a density_2d_filled ggplot with a wrapper around `ggplot()` + [geom_density_2d_filled()][ggplot2::geom_density_2d_filled()].
 #'
 #' @inheritParams gg_blanket
 #'

R/gg_errorbar.R

@@ -1,6 +1,6 @@
 #' @title Errorbar ggplot
 #'
-#' @description Create a errorbar ggplot with a wrapper around ggplot() + geom_errorbar.
+#' @description Create a errorbar ggplot with a wrapper around `ggplot()` + [geom_errorbar()][ggplot2::geom_errorbar()].
 #'
 #' @inheritParams gg_blanket
 #'

R/gg_freqpoly.R

@@ -1,6 +1,6 @@
 #' @title Freqpoly ggplot
 #'
-#' @description Create a freqpoly ggplot with a wrapper around ggplot() + geom_freqpoly.
+#' @description Create a freqpoly ggplot with a wrapper around `ggplot()` + [geom_freqpoly()][ggplot2::geom_freqpoly()].
 #'
 #' @inheritParams gg_blanket
 #'

R/gg_function.R

@@ -1,6 +1,6 @@
 #' @title Function ggplot
 #'
-#' @description Create a function ggplot with a wrapper around ggplot() + geom_function.
+#' @description Create a function ggplot with a wrapper around `ggplot()` + [geom_function()][ggplot2::geom_function()].
 #'
 #' @inheritParams gg_blanket
 #'

R/gg_hex.R

@@ -1,6 +1,6 @@
 #' @title Hex ggplot
 #'
-#' @description Create a hex ggplot with a wrapper around ggplot() + geom_hex.
+#' @description Create a hex ggplot with a wrapper around `ggplot()` + [geom_hex()][ggplot2::geom_hex()].
 #'
 #' @inheritParams gg_blanket
 #'

R/gg_histogram.R

@@ -1,6 +1,6 @@
 #' @title Histogram ggplot
 #'
-#' @description Create a histogram ggplot with a wrapper around ggplot() + geom_histogram.
+#' @description Create a histogram ggplot with a wrapper around `ggplot()` + [geom_histogram()][ggplot2::geom_histogram()].
 #'
 #' @inheritParams gg_blanket
 #'