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

SSplots: "summaryoutput" variable inconsistency for "timeseries" SSplots #70

Open
efletcherPIFSC opened this issue Jan 11, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation question Further information is requested topic: ss-plots Relating to ssplot functions derived from r4ss
Milestone

Comments

@efletcherPIFSC
Copy link
Collaborator

efletcherPIFSC commented Jan 11, 2023

SSplotEnsemble, SSplotModelComp, SSplotHCXval, and SSplotRetro have the primary (or first) argument, with different names, and documented differently. However these values are very simlar: they are derived from r4ss::SSsummarize .

  • SSplotEnsemble: kb SSdeltaMVLN $kb type output
  • SSplotModelComp: summaryoutput List created by r4ss::SSsummarize()
  • SSplotHCXval: retroSummary List created by r4ss::SSsummarize() or ss3diags::SSretroComps()
  • SSplotRetro: summaryoutput List created by r4ss::SSsummarize()

All four functions would have the primary argument as summaryoutput defined as "List created by r4ss::SSsummarize()". SSplotEnsemble and SSplotHCXval will need to rename their variables to summaryoutput, but it is the same functionality. However, does these changes affect the context of any of the function documentation?

@efletcherPIFSC efletcherPIFSC added documentation Improvements or additions to documentation question Further information is requested topic: ss-plots Relating to ssplot functions derived from r4ss labels Jan 11, 2023
@MOshima-PIFSC
Copy link
Contributor

Hi Eric,
I don't think the SSplotEnsemble() kb object is the same as the summaryoutput object. The kb object is created from the SSdeltaMVLN() function and has a different structure than the other summaryoutput objects.
I think it is ok to change retroSummary to summaryoutput but it might be helpful to add a note somewhere that it is the summarized list from the retrospective runs and if they are plotting age or length composition data, then they will need to use ss3diags::SSretroComps() instead of r4ss::SSsummarize(). This note should probably be added to SSplotRetro() as well.

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 question Further information is requested topic: ss-plots Relating to ssplot functions derived from r4ss
Projects
None yet
Development

No branches or pull requests

2 participants