Discussion with @e-perl-NOAA about where the additional documentation about a particular output table suggested in #234 led to a bigger-picture idea of documenting the Report.sso file.
The Report.sso file sections are listed in a few places
I think these three sources could be combined into a more useful table following a format like the following:
Number
Description
Keyword
r4ss name
Notes
7
Mortality and growth parameters by year after adjustments
MGparm_By_Year_after_adjustments
$MGparmAdj
This block shows the time series of mortality and growth parameters by year after adjustments by environmental links, blocks and deviations.
8
Selectivity parameters (size) by year after adjustments
selparm(Size)_By_Year_after_adjustments
$SelSizeAdj
This block shows the size selectivity parameters, after adjustment, for each year in which a change occurs.
The biggest challenge I see is that if documentation in the "Notes" column gets long (e.g. by describing the est_rho and D-W columns as discussed in #234), the table may become too large.
Discussion with @e-perl-NOAA about where the additional documentation about a particular output table suggested in #234 led to a bigger-picture idea of documenting the Report.sso file.
The Report.sso file sections are listed in a few places
I think these three sources could be combined into a more useful table following a format like the following:
The biggest challenge I see is that if documentation in the "Notes" column gets long (e.g. by describing the
est_rho
andD-W
columns as discussed in #234), the table may become too large.