[feat] Extract and format data for asar to SIS function - #365
sbreitbart-NOAA wants to merge 11 commits into
Conversation
| #' | ||
| #' @details This function acts within the following workflow: | ||
| #' | ||
| #' 1. When a stock assessment is scheduled to conclude, SIS will generate an |
There was a problem hiding this comment.
What do you mean SIS will generate? I think clarity here is needed saying a specific function.
There was a problem hiding this comment.
How about "automatically assign"?
| #' 2b. Locate the files in the "report" folder generated by running `asar::create_template()`. | ||
| #' 2c. Run `stockplotr::extract_sis_data()`, which will populate the templates with data originating from a converted model results file. | ||
| #' 3. The user will add the remaining necessary data into the csv files, ensuring that all required fields are completed. | ||
| #' 4. Run `export_to_sis()`, which will format and upload this data to a specific Google Drive folder. |
There was a problem hiding this comment.
Maybe we should make a wrapper like add_accessibility that performs this fxn and export_to_sis together
There was a problem hiding this comment.
I like the idea of saving the user time, but that might come at the cost of them not inspecting their files before sending to SIS. I think we should encourage them to make sure it looks right before doing so
| "recruitment" = "Recruitment", | ||
| "catch" = "Catch", | ||
| "spawning_biomass" = "Spawners", | ||
| "abundance" = "Abundance", # aka biomass |
There was a problem hiding this comment.
abundance and biomass are not the same
There was a problem hiding this comment.
I was confused too; Jeff confirmed that "Abundance = Biomass - or - Spawners". I'm going to inquire further
|
This is really coming together! I do feel quite strongly that the users should be able to use this function without creating the RDAs; however, I do see why the approach here is more reasonable. Playing devil's advocate, I do think that if a user wants to send their info to SIS and doesn't use I think we need to really think about the purpose of this function. Is it only for users who use I can see both sides to this. Since With that said and thinking on it, proceed as planned and continue with this approach. I think we can assess the utility of it with some test cases (the steering committee or other willing users) once we get this out there and talk with the SIS devs. |
…emove it in next commit
…es with different figures/tables available
db5fd88 to
a9c028b
Compare
Extract and format data for asar to SIS function
Note: this branch is a companion to https://github.com/nmfs-ost/asar/tree/sis-data, which intakes the templates (blank or filled in, with this function) and sends them to Google Drive
@Schiano-NOAA This works by extracting data from rdas, not creating them within the function. I'm not sure that it'd be worth adding in the capability to create rdas within the function, as it'd need to be highly interactive (asking authors for arguments that impact key quantities), and this works even if rdas are missing.
This still needs some work (see below) but wanted to share it/ask for feedback/spark discussion before I got too far: