Format @title and @param fields following tidyverse style guide

Author: nanxstats

R/continuous-gsea.R

@@ -1,14 +1,14 @@
-#' The GSEA GenePattern Color Palettes
+#' The GSEA GenePattern color palettes
 #'
 #' Color palette inspired by the colors used in the
 #' heatmaps plotted by GSEA GenePattern.
 #'
 #' @param palette Palette type.
-#' Currently there is one available option: `"default"`
-#' (continuous palette with 12 base colors).
+#'   Currently there is one available option: `"default"`
+#'   (continuous palette with 12 base colors).
 #' @param n Number of individual colors to be generated.
 #' @param alpha Transparency level, a real number in (0, 1].
-#' See `alpha` in [grDevices::rgb()] for details.
+#'   See `alpha` in [grDevices::rgb()] for details.
 #' @param reverse Logical. Should the order of the colors be reversed?
 #'
 #' @export rgb_gsea
@@ -43,7 +43,7 @@ rgb_gsea <- function(palette = c("default"), n = 12, alpha = 1, reverse = FALSE)
   alpha_cols
 }
 
-#' The GSEA GenePattern Color Palettes
+#' The GSEA GenePattern color palettes
 #'
 #' Color palette inspired by the colors used in the
 #' heatmaps plotted by GSEA GenePattern.
@@ -66,12 +66,12 @@ pal_gsea <- function(palette = c("default"), n = 12, alpha = 1, reverse = FALSE)
   manual_pal(unname(alpha_cols))
 }
 
-#' The GSEA GenePattern Color Scales
+#' The GSEA GenePattern color scales
 #'
 #' See [pal_gsea()] for details.
 #'
 #' @inheritParams pal_gsea
-#' @param ... additional parameters for [ggplot2::discrete_scale()]
+#' @param ... Additional parameters for [ggplot2::discrete_scale()].
 #'
 #' @export scale_color_gsea
 #'

R/continuous-material.R

@@ -1,34 +1,34 @@
-#' Material Design Color Palettes
-#'
-#' The Material Design color palettes.
-#'
-#' @param palette Palette type.
-#' There are 19 available options:
-#' \itemize{
-#' \item `"red"`
-#' \item `"pink"`
-#' \item `"purple"`
-#' \item `"deep-purple"`
-#' \item `"indigo"`
-#' \item `"blue"`
-#' \item `"light-blue"`
-#' \item `"cyan"`
-#' \item `"teal"`
-#' \item `"green"`
-#' \item `"light-green"`
-#' \item `"lime"`
-#' \item `"yellow"`
-#' \item `"amber"`
-#' \item `"orange"`,
-#' \item `"deep-orange"`
-#' \item `"brown"`
-#' \item `"grey"`
-#' \item `"blue-grey"`}
-#' See [Material Design color system](https://m2.material.io/design/color/the-color-system.html)
-#' for details.
+#' Material Design color palettes
+#'
+#' The Material Design 2 color palettes.
+#'
+#' @param palette Palette type. There are 19 available options:
+#'   - `"red"`
+#'   - `"pink"`
+#'   - `"purple"`
+#'   - `"deep-purple"`
+#'   - `"indigo"`
+#'   - `"blue"`
+#'   - `"light-blue"`
+#'   - `"cyan"`
+#'   - `"teal"`
+#'   - `"green"`
+#'   - `"light-green"`
+#'   - `"lime"`
+#'   - `"yellow"`
+#'   - `"amber"`
+#'   - `"orange"`,
+#'   - `"deep-orange"`
+#'   - `"brown"`
+#'   - `"grey"`
+#'   - `"blue-grey"`
+#'
+#'   For details, see [Material Design color
+#'   system](https://m2.material.io/design/color/the-color-system.html).
+#'
 #' @param n Number of individual colors to be generated.
 #' @param alpha Transparency level, a real number in (0, 1].
-#' See `alpha` in [grDevices::rgb()] for details.
+#'   See `alpha` in [grDevices::rgb()] for details.
 #' @param reverse Logical. Should the order of the colors be reversed?
 #'
 #' @export rgb_material
@@ -68,9 +68,9 @@ rgb_material <- function(
   alpha_cols
 }
 
-#' Material Design Color Palettes
+#' Material Design color palettes
 #'
-#' The Material Design color palettes.
+#' The Material Design 2 color palettes.
 #'
 #' @inheritParams rgb_material
 #'
@@ -96,12 +96,12 @@ pal_material <- function(
   manual_pal(unname(alpha_cols))
 }
 
-#' Material Design Color Palettes
+#' Material Design color palettes
 #'
 #' See [pal_material()] for details.
 #'
 #' @inheritParams pal_material
-#' @param ... additional parameters for [ggplot2::discrete_scale()]
+#' @param ... Additional parameters for [ggplot2::discrete_scale()].
 #'
 #' @export scale_color_material
 #'

R/discrete-aaas.R

@@ -1,14 +1,14 @@
-#' AAAS Journal Color Palettes
+#' AAAS journal color palettes
 #'
 #' Color palettes inspired by plots in journals published by
 #' American Association for the Advancement of Science (AAAS),
-#' such as *Science* and *Science Translational Medicine*.
+#' such as _Science_ and _Science Translational Medicine_.
 #'
 #' @param palette Palette type.
-#' Currently there is one available option: `"default"`
-#' (10-color palette inspired by *Science*).
+#'   Currently there is one available option: `"default"`
+#'   (10-color palette inspired by _Science_).
 #' @param alpha Transparency level, a real number in (0, 1].
-#' See `alpha` in [grDevices::rgb()] for details.
+#'   See `alpha` in [grDevices::rgb()] for details.
 #'
 #' @export pal_aaas
 #'
@@ -37,12 +37,12 @@ pal_aaas <- function(palette = c("default"), alpha = 1) {
   manual_pal(unname(alpha_cols))
 }
 
-#' AAAS Journal Color Scales
+#' AAAS journal color scales
 #'
 #' See [pal_aaas()] for details.
 #'
 #' @inheritParams pal_aaas
-#' @param ... additional parameters for [ggplot2::discrete_scale()]
+#' @param ... Additional parameters for [ggplot2::discrete_scale()].
 #'
 #' @export scale_color_aaas
 #'

R/discrete-bmj.R

@@ -1,12 +1,12 @@
-#' BMJ Color Palettes
+#' BMJ color palettes
 #'
 #' Color palette from the BMJ living style guide.
 #'
 #' @param palette Palette type.
-#' Currently there is one available option: `"default"`
-#' (9-color palette).
+#'   Currently there is one available option: `"default"`
+#'   (9-color palette).
 #' @param alpha Transparency level, a real number in (0, 1].
-#' See `alpha` in [grDevices::rgb()] for details.
+#'   See `alpha` in [grDevices::rgb()] for details.
 #'
 #' @export pal_bmj
 #'
@@ -38,12 +38,12 @@ pal_bmj <- function(palette = c("default"), alpha = 1) {
   manual_pal(unname(alpha_cols))
 }
 
-#' BMJ Color Scales
+#' BMJ color scales
 #'
 #' See [pal_bmj()] for details.
 #'
 #' @inheritParams pal_bmj
-#' @param ... additional parameters for [ggplot2::discrete_scale()]
+#' @param ... Additional parameters for [ggplot2::discrete_scale()].
 #'
 #' @export scale_color_bmj
 #'

R/discrete-cosmic.R

@@ -1,17 +1,18 @@
-#' COSMIC Color Palettes
+#' COSMIC color palettes
 #'
 #' Color palettes inspired by the colors used in projects from the
 #' [Catalogue Of
-#' Somatic Mutations in Cancers (COSMIC)](https://cancer.sanger.ac.uk/cosmic)
+#' Somatic Mutations in Cancers (COSMIC)](https://cancer.sanger.ac.uk/cosmic).
 #'
 #' @param palette Palette type. Currently there are three available options:
-#' `"signature_substitutions"` (6-color palette),
-#' `"hallmarks_light"` (10-color palette), and `"hallmarks_dark"`
-#' (10-color palette). The `"hallmarks_light"` option is from
-#' [Hanahan and Weinberg (2011)](https://pubmed.ncbi.nlm.nih.gov/21376230/).
+#'   - `"signature_substitutions"` (6-color palette).
+#'   - `"hallmarks_light"` (10-color palette).
+#'   - `"hallmarks_dark"` (10-color palette).
 #'
+#'   The `"hallmarks_light"` option is from
+#'   [Hanahan and Weinberg (2011)](https://pubmed.ncbi.nlm.nih.gov/21376230/).
 #' @param alpha Transparency level, a real number in (0, 1].
-#' See `alpha` in [grDevices::rgb()] for details.
+#'   See `alpha` in [grDevices::rgb()] for details.
 #'
 #' @export pal_cosmic
 #'
@@ -47,12 +48,12 @@ pal_cosmic <- function(
   manual_pal(unname(alpha_cols))
 }
 
-#' COSMIC Color Scales
+#' COSMIC color scales
 #'
 #' See [pal_cosmic()] for details.
 #'
 #' @inheritParams pal_cosmic
-#' @param ... additional parameters for [ggplot2::discrete_scale()]
+#' @param ... Additional parameters for [ggplot2::discrete_scale()].
 #'
 #' @export scale_color_cosmic
 #'

R/discrete-d3.R

@@ -1,15 +1,14 @@
-#' D3.js Color Palettes
+#' D3.js color palettes
 #'
 #' Color palettes based on the colors used by D3.js.
 #'
-#' @param palette Palette type.
-#' There are 4 available options:
-#' `"category10"` (10-color palette);
-#' `"category20"` (20-color palette);
-#' `"category20b"` (20-color palette);
-#' `"category20c"` (20-color palette).
+#' @param palette Palette type. There are four available options:
+#'   - `"category10"` (10-color palette).
+#'   - `"category20"` (20-color palette).
+#'   - `"category20b"` (20-color palette).
+#'   - `"category20c"` (20-color palette).
 #' @param alpha Transparency level, a real number in (0, 1].
-#' See `alpha` in [grDevices::rgb()] for details.
+#'   See `alpha` in [grDevices::rgb()] for details.
 #'
 #' @export pal_d3
 #'
@@ -43,12 +42,12 @@ pal_d3 <- function(palette = c("category10", "category20", "category20b", "categ
   manual_pal(unname(alpha_cols))
 }
 
-#' D3.js Color Scales
+#' D3.js color scales
 #'
 #' See [pal_d3()] for details.
 #'
 #' @inheritParams pal_d3
-#' @param ... additional parameters for [ggplot2::discrete_scale()]
+#' @param ... Additional parameters for [ggplot2::discrete_scale()].
 #'
 #' @export scale_color_d3
 #'

R/discrete-flatui.R

@@ -1,14 +1,13 @@
-#' Flat UI Color Palettes
+#' Flat UI color palettes
 #'
-#' Color palettes inspired by the colors used in *Flat UI Colors*.
+#' Color palettes inspired by the Flat UI colors.
 #'
-#' @param palette Palette type.
-#' Currently there are three available option:
-#' `"default"` (10-color palette).
-#' `"flattastic"` (12-color palette).
-#' `"aussie"` (10-color palette).
+#' @param palette Palette type. Currently there are three available options:
+#'   - `"default"` (10-color palette).
+#'   - `"flattastic"` (12-color palette).
+#'   - `"aussie"` (10-color palette).
 #' @param alpha Transparency level, a real number in (0, 1].
-#' See `alpha` in [grDevices::rgb()] for details.
+#'   See `alpha` in [grDevices::rgb()] for details.
 #'
 #' @export pal_flatui
 #'
@@ -39,12 +38,12 @@ pal_flatui <- function(palette = c("default", "flattastic", "aussie"), alpha = 1
   manual_pal(unname(alpha_cols))
 }
 
-#' Flat UI Color Scales
+#' Flat UI color scales
 #'
 #' See [pal_flatui()] for details.
 #'
 #' @inheritParams pal_flatui
-#' @param ... additional parameters for [ggplot2::discrete_scale()]
+#' @param ... Additional parameters for [ggplot2::discrete_scale()].
 #'
 #' @export scale_color_flatui
 #'

R/discrete-frontiers.R

@@ -1,12 +1,12 @@
-#' Frontiers Color Palettes
+#' Frontiers journal color palettes
 #'
-#' Color palettes inspired by the colors used in *Frontiers*.
+#' Color palettes inspired by the colors used in _Frontiers_ journals.
 #'
 #' @param palette Palette type.
-#' Currently there is one available option: `"default"`
-#' (10-color palette).
+#'   Currently there is one available option: `"default"`
+#'   (10-color palette).
 #' @param alpha Transparency level, a real number in (0, 1].
-#' See `alpha` in [grDevices::rgb()] for details.
+#'   See `alpha` in [grDevices::rgb()] for details.
 #'
 #' @export pal_frontiers
 #'
@@ -35,12 +35,12 @@ pal_frontiers <- function(palette = c("default"), alpha = 1) {
   manual_pal(unname(alpha_cols))
 }
 
-#' Frontiers Color Scales
+#' Frontiers journal color scales
 #'
 #' See [pal_frontiers()] for details.
 #'
 #' @inheritParams pal_frontiers
-#' @param ... additional parameters for [ggplot2::discrete_scale()]
+#' @param ... Additional parameters for [ggplot2::discrete_scale()].
 #'
 #' @export scale_color_frontiers
 #'

R/discrete-futurama.R

@@ -1,12 +1,12 @@
-#' The Futurama Color Palettes
+#' Futurama color palettes
 #'
-#' Color palettes inspired by the colors used in *Futurama*.
+#' Color palettes inspired by the colors used in _Futurama_.
 #'
 #' @param palette Palette type.
-#' Currently there is one available option: `"planetexpress"`
-#' (12-color palette).
+#'   Currently there is one available option: `"planetexpress"`
+#'   (12-color palette).
 #' @param alpha Transparency level, a real number in (0, 1].
-#' See `alpha` in [grDevices::rgb()] for details.
+#'   See `alpha` in [grDevices::rgb()] for details.
 #'
 #' @export pal_futurama
 #'
@@ -35,12 +35,12 @@ pal_futurama <- function(palette = c("planetexpress"), alpha = 1) {
   manual_pal(unname(alpha_cols))
 }
 
-#' The Futurama Color Scales
+#' Futurama color scales
 #'
 #' See [pal_futurama()] for details.
 #'
 #' @inheritParams pal_futurama
-#' @param ... additional parameters for [ggplot2::discrete_scale()]
+#' @param ... Additional parameters for [ggplot2::discrete_scale()].
 #'
 #' @export scale_color_futurama
 #'