Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ss3rep parameter documentation #71

Open
efletcherPIFSC opened this issue Jan 24, 2023 · 2 comments
Open

ss3rep parameter documentation #71

efletcherPIFSC opened this issue Jan 24, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@efletcherPIFSC
Copy link
Collaborator

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

  • SSCompsTA1.8: Stock Synthesis output as read by r4SS function SS_output
  • SSdeltaMVLN: from r4ss::SS_output
  • SSdeltaMVLN_old: from r4ss::SSgetoutput()$replist1
  • SSdiagsMCMC: from r4ss::SS_output
  • SSdiagsMCMC_ancient: from r4ss::SS_output
  • SSsettingsBratioF: from r4ss::SSgetoutput()
  • SSrmse: output from SS_output()
  • SSplotRunsTest: Stock Synthesis output as read by r4SS function SS_output

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 efletcherPIFSC added the documentation Improvements or additions to documentation label Jan 24, 2023
@efletcherPIFSC efletcherPIFSC added this to the ss3diags 2.2.0 milestone Jan 24, 2023
@efletcherPIFSC
Copy link
Collaborator Author

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
Copy link
Contributor

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()].

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: No status
Development

No branches or pull requests

2 participants