[feat] Add units to converter

R/convert_output.R

@@ -70,7 +70,6 @@ convert_output <- function(
     birthseas = NA,
     initial = NA,
     estimate = NA,
-    # units = NA,
     uncertainty = NA,
     uncertainty_label = NA,
     likelihood = NA,
@@ -169,6 +168,7 @@ convert_output <- function(
 
 
   #### SS3 ####
+  # SS3 groupings: https://docs.google.com/spreadsheets/d/11-k0xOo3Bit1MbJf2ZjmymzsUNCRhgGkVfXV1jNEdbM/edit?gid=0#gid=0
   # Convert SS3 output Report.sso file
   if (tolower(model) == "ss3") {
     if (is.character(file)) {
@@ -348,9 +348,6 @@ convert_output <- function(
       info <- c()
     }
 
-    # Extract units
-
-
     # Loop for all identified parameters to extract for plotting and use
     # Create list of parameters that were not found in the output file
     # 1,4,10,17,19,20,22,32,37

README.md

@@ -10,20 +10,11 @@
 
 ***Previously named 'satf'***
 
-The goal of {stockplotr} is to create a centralized package that contains all of
-the figures and tables for a stock assessment report used to inform management. 
-There are multiple current packages that perform a 
-similar function, but they are typically region and/or model dependent. Across 
-the US, there are multiple packages that create plots that are directly used in 
-a stock assessment report used for management. For example, an analyst that uses 
-Stock Synthesis (SS3) to assess a stock will utilize [`r4ss`](https://github.com/r4ss/r4ss/), 
-a package that reads outputs, plots key parameters, and more to increase 
-throughput and reduce tedious tasks for an analyst.
-
-Please note that this package is still in development. As such, some functions 
-are unstable and might not perform as intended. We encourage anyone who tests 
-out this package to leave an [issue](https://github.com/nmfs-ost/stockplotr/issues)
-for any errors you find or for a feature request.
+The goal of {stockplotr} is to create a centralized package that contains all of the figures and tables for a stock assessment report used to inform management. 
+There are multiple current packages that perform a similar function, but they are typically region and/or model dependent. Across the US, there are multiple packages that create plots that are directly used in 
+a stock assessment report used for management. For example, an analyst that uses Stock Synthesis (SS3) to assess a stock will utilize [`r4ss`](https://github.com/r4ss/r4ss/), a package that reads outputs, plots key parameters, and more to increase throughput and reduce tedious tasks for an analyst.
+
+Please note that this package is still in development. As such, some functions are unstable and might not perform as intended. We encourage anyone who tests out this package to leave an [issue](https://github.com/nmfs-ost/stockplotr/issues) for any errors you find or for a feature request.
 
 ## Installation
 
@@ -93,10 +84,7 @@ All contributors participating and contributing to the asar project are expected
 
 ## User Community
 
-We hope that this package will be able to be a one stop shop for plots regarding 
-interpreting assessment models and presenting the results to managers and relevant 
-stakeholders. We encourage interested users to contribute to this package using 
-their custom code when they find it may be useful across the nation.
+We hope that this package will be able to be a one stop shop for plots regarding interpreting assessment models and presenting the results to managers and relevant stakeholders. We encourage interested users to contribute to this package using their custom code when they find it may be useful across the nation.
 
 > [!NOTE]
 > Model diagnostic plots within the [{Fisheries Integrated Modelling System (FIMS)}] (https://github.com/NOAA-FIMS/FIMS) are in development.