[Review]: convert_output() documentation

[sbreitbart-NOAA]

Directions

Please comment on the follow topics regarding documentation of the function convert_output():

• Title
• Description
• Arguments
• Return
• Examples

Think about the perspective of both new and advanced users when reviewing the documentation.

You can access the documentation quickly and easily by running ?stockplotr::convert_output in your console. Remember to only focus on the documentation. Feel free to make a note of it in our meeting notes if something comes up.

[okenk]

I think either the description of file or an additional "details" section should more clearly specify what file you need to provide for each of the three models (e.g., Report.sso for stock synthesis).

I am not totally clear on fleet_names, possibly because I am only familiar with SS3. For SS3, the function should be able to read in the fleet names without any user input. Does that mean this argument is optional? Is it a chance for the user to rename the fleets? Or does it have to match the assessment? Maybe, like above, the documentation should just spell out directions for each model instead of trying to use more general language.

Under value, I suggest replacing "standardized version" with "standardized data frame". There is also a typo where it reads "building a stock assessment reports".

Not technically about documentation, but I prefer saving data frames as csv files instead of rda files. The two benefits are 1) you can preview them outside of R (including github web interface) and 2) in git it generally requires less space to track a csv file than a binary file like an rda, because it only has to track changes to the csv. This can prevent repos from getting unwieldy and slow to clone. On the other hand, I haven't noticed any benefits to rda over csv (other than being able to save things that aren't in an array form), though maybe I am unaware!