update(documentation): and other part of the function for running

NAMESPACE

@@ -4,6 +4,8 @@ export(add_theme)
 export(exp_fig_accessible)
 export(plot_landings)
 export(plot_recruitment)
+export(plot_recruitment_deviations)
+export(plot_spawn_recruitment)
 export(plot_spawning_biomass)
 export(plot_total_biomass)
 export(table_indices)

R/plot_recruitment_deviations.R

@@ -2,18 +2,16 @@
 #'
 #'  @inheritParams plot_recruitment
 #'
-#' @returnPlot Plot recruitment deviations relative to one over time from an assessment model output file
-#' translated to a standardized output. There are options to return a {ggplot2}
-#' object or export an .rda object containing associated caption and alternative
-#' text for the figure.
+#' @return Plot recruitment deviations relative to one over time from an
+#' assessment model output file translated to a standardized output. There are
+#' options to return a {ggplot2} object or export an .rda object containing
+#' associated caption and alternative text for the figure.
 #' @export
 #'
-#' @examples
-plot_recruitment_deviations <- function(
+plot_recruitment_deviations <- function (
     dat = NULL,
     end_year = NULL,
-    n_projected_years = 10,
-
+    n_projected_years = 10
 ) {
   if (is.null(end_year)) {
     end_year <- max(as.numeric(dat$year), na.rm = TRUE) - n_projected_years

R/plot_spawn_recruitment.R

@@ -4,10 +4,9 @@
 #'  @param spawning_biomass_label Units for spawning biomass
 #'  @param recruitment_label units for recruitment
 #'
-#' @return
+#' @return Plot spawning recruitment relationship from a standardized output file originating from asar::convert_output()
 #' @export
 #'
-#' @examples
 plot_spawn_recruitment <- function(
     dat = NULL,
     spawning_biomass_label = "metric tons",
@@ -62,5 +61,5 @@ plot_spawn_recruitment <- function(
     ggplot2::labs(x = glue::glue("Spawning Biomass ({spawning_biomass_label})"),
                   y = glue::glue("Recruitment ({recruitment_label})")) +
     ggplot2::theme(legend.position = "none")
-  # sr_plt <- add_theme(sr_plt)
+  suppressWarnings(add_theme(sr_plt))
 }