Create executive summary tables from an SS3 Report.sso file
Source:R/table_exec_summary.R
table_exec_summary.RdTake the output from SS_output() and create executive summary .rda files
as required by the current Terms of Reference for U.S. West Coast
groundfish assessments. Additionally, .rda files of historical catches,
time-series, and numbers-at-age are created. A CSV file with captions is
also created. This function is modified from SSexecutivesummary()
associated with the adoption of the asar template.
Usage
table_exec_summary(
replist,
dir = NULL,
ci_value = 0.95,
fleetnames = NULL,
so_units = "biomass (mt)",
endyr = NULL,
verbose = TRUE
)Arguments
- replist
A list object created by
SS_output().- dir
Directory where the .rda files will be written. The default value is NULL where a table folder will be created where the Report.sso file is located associated with
replist.- ci_value
To calculate confidence intervals, the desired interval must be specified. The default is 0.95.
- fleetnames
String of fleet names. Default is NULL which will use the the model fleet names.
- so_units
A single character object specifying the unit of measurement that spawning output is reported in. The default is "millions of eggs". This text will be used in the table captions. If fecundity is equal to weight-at-length, then the units are hard-wired to
"mt"regardless of what is used within this argument.- endyr
Optional input to choose a different ending year for tables, which could be useful for catch-only updates. The default is
NULL, which leads to using the ending year defined in Report.sso.- verbose
A logical value specifying if output should be printed to the screen.
See also
Other table functions:
table_all(),
table_biology(),
table_compweight(),
table_config(),
table_parcounts(),
table_pars(),
table_ts()