Inherit common SSplot Parameters #94
Conversation
merge macos-latest-release fix
…sessments/ss3diags into feat-roxygen-params
efletcherPIFSC
added
documentation
|
@MOshima-PIFSC
|
| #' @param kb `kb` type output created by `SSdeltaMVLN()` | ||
| #' @param subplots vector to create subplots with these options: | ||
| #' \itemize{ | ||
| #' \item `"stock"` Fish Population |
There was a problem hiding this comment.
I would say stock is 'Stock biomass relative to reference point (B/BMSY)' and harvest 'Harvest rate relative to reference point (F/FMSY)'
R/SSplotHCxval.R
Outdated
| #' \itemize{ | ||
| #' \item `"cpue"` Index data | ||
| #' \item `"len"` Length composition data | ||
| #' \item `"age"` Age composition data (yet to be tested) |
There was a problem hiding this comment.
Age composition data has been tested and works, can remove the 'yet to be tested'
There was a problem hiding this comment.
Hey @efletcherPIFSC I looked over the subplots descriptions. They look good, I just added a few comments/suggestions to them. Also, I noted it in SSplotRunstest.R but any of the functions that have a quants argument, the same type of bulleted list can be used for those as well.
|
@MOshima-PIFSC Didn't resolve any git code conflicts. Hence the dirty git conflict code. Fixing that. |
Created generic functions
SSplotGeneric,SSplotGenericLegend,SSplotGenericPar,SSplotGenericUncertiantyto re-use common parameter documentation that ss3diags SSplot functions, via use roxygen tag@inheritParams. Resolves #2.Implementation of
SSplotGenericParresolves #66.In addition:
subplots,indexfleets, andpunitsare listed in a bulleted list