SSexecutivesummary: A function to create a executive summary tables from an SS...

Description Usage Arguments Value Author(s)

Description

Reads the Report.sso within the directory and creates executive summary tables as required by the current Terms of Reference for West Coast groundfish. Works with Stock Synthesis versions 3.24U and later. Additionally, historical catch and numbers at ages tables are created.

Usage

1
2
3
4
SSexecutivesummary(dir, plotdir = "default", quant = 0.95,
  es.only = FALSE, tables = c("a", "b", "c", "d", "e", "f", "g", "h",
  "i", "catch", "numbers"), nsex = FALSE, endyr = NULL,
  verbose = TRUE)

Arguments

dir

Locates the directory of the files to be read in, double backslashes (or forwardslashes) and quotes necessary.

plotdir

Directory where the 'tables' directory will be created. The default is the dir location where the Report.sso file is located.

quant

To calculate confidence intervals, default is set at 0.95

es.only

TRUE/FALSE switch to produce only the executive summary tables will be produced, default is FALSE which will return all executive summary tables, historical catches, and numbers-at-ages

tables

Which tables to produce (default is everything). Note: some tables depend on calculations related to previous tables, so will fail if requested on their own (e.g. Table 'f' can't be created without also creating Table 'a')

nsex

This will allow the user to calculate single sex values based on the new sex specification (-1) in SS for single sex models. Default value is FALSE. TRUE will not divide by 2.

endyr

Optional input to choose a different ending year for tables (could be useful for catch-only updates)

verbose

Return updates of function progress to the R console?

Value

A csv files containing executive summary tables.

Author(s)

Chantel Wetzel


r4ss documentation built on Oct. 30, 2019, 11:25 a.m.