combine man pages of plot_* and prep_* function pairs (#141)

R/prep_sankey.R

@@ -1,5 +1,3 @@
-#' Prepare data to plot using `plot_sankey()`
-#'
 #' @param data_alignment data.frame. Holds aggregated alignment metrics per
 #'   company for tms sectors. Must contain columns: `"name_abcd"`,
 #'   `"sector"` and any column implied by `group_var`.
@@ -12,10 +10,11 @@
 #'   plotted in sankey plot. Must be present in `data_alignment`.
 #'
 #' @return data.frame
+#'
 #' @export
 #'
-#' @examples
-#' # TODO
+#' @rdname plot_sankey
+
 prep_sankey <- function(data_alignment,
                         region,
                         year,

R/prep_scatter.R

@@ -1,5 +1,3 @@
-#' Prepare data to plot scatterplot
-#'
 #' @param data_bopo data.frame. Data containing buildout and phaseout alignment
 #'   values. Must contain columns: `'year'`, `'sector'`, `'region'`,
 #'   `'direction'` and either `'name_abcd'` and `'alignment_metric'` or
@@ -17,10 +15,11 @@
 #' @param groups_to_plot Character vector. Groups to filter on.
 #'
 #' @return data.frame
+#'
 #' @export
 #'
-#' @examples
-#' # TODO
+#' @rdname plot_scatter
+
 prep_scatter <- function(data_bopo,
                          data_net,
                          data_level = c("group_var", "company"),

R/prep_scatter_alignment_exposure.R

@@ -1,5 +1,3 @@
-#' Prepare data to plot using `plot_scatter_alignment_exposure()`
-#'
 #' @param data data.frame. Holds net aggregated alignment metrics on the loan
 #'   book level. Must contain columns: `"scenario"`, `"region"`,
 #'   `"sector"`, `"year"`, `"exposure_weighted_net_alignment"`,
@@ -15,10 +13,11 @@
 #'   Defaults to `"benchmark"`.
 #'
 #' @return data.frame
+#'
 #' @export
 #'
-#' @examples
-#' # TODO
+#' @rdname plot_scatter_alignment_exposure
+
 prep_scatter_alignment_exposure <- function(data,
                                             year,
                                             region,

R/prep_scatter_animated.R

@@ -1,5 +1,3 @@
-#' Prepare data to plot animated scatterplot
-#'
 #' @param data_bopo data.frame. Data containing buildout and phaseout alignment
 #'   values. Must contain columns: `'year'`, `'sector'`, `'region'`,
 #'   `'direction'` and either `'name_abcd'` and `'alignment_metric'` or
@@ -15,10 +13,11 @@
 #' @param groups_to_plot Character vector. Groups to filter on.
 #'
 #' @return data.frame
+#'
 #' @export
 #'
-#' @examples
-#' # TODO
+#' @rdname plot_scatter_animated
+
 prep_scatter_animated <- function(data_bopo,
                                   data_net,
                                   data_level = c("group_var", "company"),