PIFSCstockassessments / ss3diags

R package with advanced diagnostics to evaluate a Stock Synthesis model. Diagnostics include residual analyses, hindcasting and cross-validation techniques, and retrospective analyses.
http://pifscstockassessments.github.io/ss3diags/
2 stars 4 forks source link

`ss3rep` parameter documentation #71

Open efletcherPIFSC opened 1 year ago

efletcherPIFSC commented 1 year ago

The parameter ss3rep is used and documented in the following functions:

With the exception used in SSdeltaMVLN_old, the documentation can be consolidated to state ss3rep is an Stock Synthesis output object generated by r4ss::SS_output.

efletcherPIFSC commented 1 year ago

Value for SSdeltaMVLN_old come from the replist1 parameter of [r4ss::SSgetoutput()]

The rest of the functions can state it came from [r4ss::SS_output()]

MOshima-PIFSC commented 1 year ago

I think its ok to change this to match the others. The SSgetoutput function is used to get multiple outputs at once but the function only takes one output. This was probably an artifact of how the function was used in a script at one point. To be consistent I would use [r4ss::SS_output()].