refactor: update para description

R/get_param_values.R

@@ -4,7 +4,9 @@
 #'
 #'
 #' @template mydir
-#' @param para SS3 parameter name (string) that the profile was run across.
+#' @param para A character string specifying the SS3 parameter name that the
+#'   profile pertains to. The parameter name should match the name in the
+#'   control.ss_new file from SS3.
 #' @param vec Vector of parameter values or retrospective runs the summary object contains
 #' @param summary List created by the [r4ss::SSsummarize()] function
 #'

R/get_summary.R

@@ -3,9 +3,9 @@
 #' Used by [profile_wrapper()] to write summary statistics to the disk.
 #'
 #' @template mydir
-#' @param name Identify if the csv file show jitter, retro, or profile results.
 #' @param para A character string specifying the SS3 parameter name that the
-#'   profile pertains to.
+#'   profile pertains to. The parameter name should match the name in the
+#'   control.ss_new file from SS3.
 #' @param vec A numeric vector specifying the parameter values that the
 #'   profile covers.
 #' @param profilemodels An object returned from [r4ss::SSgetoutput()].
@@ -14,7 +14,7 @@
 #' @author Chantel Wetzel & Kelli Johnson
 #' @export
 
-get_summary <- function(mydir, para, vec, name, profilemodels, profilesummary) {
+get_summary <- function(mydir, para, vec, profilemodels, profilesummary) {
 
   # Need to identify a way to determine if a model estimates male growth parameters as offsets from females
 
@@ -39,7 +39,6 @@ get_summary <- function(mydir, para, vec, name, profilemodels, profilesummary) {
   )
 
   # write tables
-  utils::write.csv(x = table(unlist(bounds)), file = file.path(mydir, paste0(name, "_parsonbounds.csv")), row.names = FALSE)
-  utils::write.csv(x = out, file = file.path(mydir, paste0(name, "_results.csv")), row.names = FALSE)
-  return()
+  utils::write.csv(x = table(unlist(bounds)), file = file.path(mydir, paste0(para, "_parsonbounds.csv")), row.names = FALSE)
+  utils::write.csv(x = out, file = file.path(mydir, paste0(para, "_results.csv")), row.names = FALSE)
 }

R/profile_plot.R

@@ -5,8 +5,9 @@
 #'
 #' @template mydir
 #' @param rep A list of model output as returned by [r4ss::SS_output()].
-#' @param para A character value that matches a parameter name as used in the
-#' SS control.ss_new parameter names.
+#' @param para A character string specifying the SS3 parameter name that the
+#'   profile pertains to. The parameter name should match the name in the
+#'   control.ss_new file from SS3.
 #' The name will be cleaned up for plotting purposes internally within the function.
 #' For example, `SR_BH_steep` becomes "Steepness (_h_)".
 #' @param profilesummary Output from [r4ss::SSsummarize()].
@@ -15,7 +16,7 @@
 #'
 #' @author Chantel Wetzel.
 #' @export
-#' @seealso [profile_wrapper] and [rerun_profile_vals] call `profile_plot`.
+#' @seealso [profile_wrapper] and [rerun_profile_vals] call `plot_profile`.
 
 plot_profile <- function(mydir, rep, para, profilesummary) {