replace Roxygen template with inline function (#611)

Author: cjyetman

.Rbuildignore

@@ -9,7 +9,6 @@
 ^cran-comments\.md$
 ^data-raw/.*$
 ^docs$
-^man-roxygen$
 ^pkgdown$
 ^r2dii\.plot\.Rproj$
 ^vignettes/r2dii-plot\.Rmd$

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: r2dii.plot
 Title: Visualize the Climate Scenario Alignment of a Financial Portfolio
-Version: 0.5.1.9005
+Version: 0.5.1.9006
 Authors@R: 
     c(person(given = "Monika",
              family = "Furdyna",

R/prep_emission_intensity.R

@@ -4,9 +4,7 @@
 #'   * The structure must be like [sda_demo].
 #'   * The column `sector` must have a single value (e.g. "cement").
 #'   * (Optional) If present, the column `label` is used for data labels.
-#' @template convert_label
-#' @templateVar fun qplot_emission_intensity
-#' @templateVar value to_title
+#' @param convert_label `r convert_label_docs("qplot_emission_intensity", "to_title")`
 #' @param span_5yr Logical. Use `TRUE` to restrict the time span to 5 years from
 #'   the start year (the default behavior of `qplot_emission_intensity()`), or use
 #'   `FALSE` to impose no restriction.

R/prep_techmix.R

@@ -9,9 +9,7 @@
 #'   * (Optional) If present, the column `label` is used for data labels.
 #'   * (Optional) If present, the column `label_tech` is used for technology
 #'   labels.
-#' @template convert_label
-#' @templateVar fun qplot_techmix
-#' @templateVar value recode_metric_techmix
+#' @param convert_label `r convert_label_docs("qplot_techmix", "recode_metric_techmix")`
 #' @param span_5yr Logical. Use `TRUE` to restrict the time span to 5 years from
 #'   the start year (the default behavior of `qplot_techmix()`), or use
 #'   `FALSE` to impose no restriction.

R/prep_trajectory.R

@@ -5,9 +5,7 @@
 #' * The following columns must have a single value: `sector`, `technology`,
 #' `region`, `scenario_source`.
 #' * (Optional) If present, the column `label` is used for data labels.
-#' @template convert_label
-#' @templateVar fun qplot_trajectory
-#' @templateVar value recode_metric_trajectory
+#' @param convert_label `r convert_label_docs("qplot_trajectory", "recode_metric_trajectory")`
 #' @param span_5yr Logical. Use `TRUE` to restrict the time span to 5 years from
 #'   the start year (the default behavior of `qplot_trajectory()`), or use
 #'   `FALSE` to impose no restriction.

R/utils-docs.R

@@ -0,0 +1,8 @@
+convert_label_docs <- function(func, default_val) {
+  glue::glue(
+    "A symbol. The unquoted name of a function to apply to y-axis labels. For example:",
+    "  * To convert labels to uppercase use `convert_label = toupper`.",
+    "  * To get the default behavior of `{func}` use `convert_label = {default_val}`.",
+    .sep = "\n"
+  )
+}