refactor: add info about case

pfmc-assessments · Sep 23, 2024 · 9fe7c68 · 9fe7c68
1 parent 4f206f8
commit 9fe7c68
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/R/get_expanded_comps.R b/R/get_expanded_comps.R
@@ -21,7 +21,8 @@
 #'   must be a string. This column can be is used to determine whether to format the
 #'   composition data for length or age compositions by looking for either age
 #'   (e.g., `age_years`, `Age`, `age`, `best_age`) or length (e.g., `length`,
-#'   `length_cm`, `Length`, `Length_cm`) in the comp_column_name. The default is `length_cm`.
+#'   `length_cm`, `Length`, `Length_cm`) in the comp_column_name. The comp_column_name
+#'   is not case sensitive.The default is `length_cm`.
 #' @param output Switch to specify how to return the composition data where the options
 #'   are c("full_expansion_ss3_format", "tow_expansion_only", "full_expansion_unformatted").
 #'   The default is `output = "full_expansion_ss3_format"` where a list is returned with

diff --git a/R/get_input_n.R b/R/get_input_n.R
@@ -18,7 +18,7 @@
 #'   is used to determine whether to format the composition data for length or age
 #'   compositions by looking for either age (e.g., `age_years`, `Age`, `best_age`) or length
 #'   (e.g., `Length`, `length`, `Length_cm`, `length_cm`) in the comp_column_name.
-#'   The default is `length_cm`.
+#'   The comp_column_name is not case sensitive. The default is `length_cm`.
 #' @param input_n_method Determines the default input sample size to add to
 #'   the composition data for SS3. There are three options: c("stewart_hamel", "tows",
 #'   "total_samples") where the default is "stewart_hamel".