Learn R Programming

r4ss (version 1.36.1)

SS_readctl: read control file from SS

Description

Read Stock Synthesis control file into list object in R. This function is a wrapper which calls either SS_readctl_3.24 or SS_readctl_3.30 (not yet written). This setup allows those functions to be cleaner (if somewhat redundant) than a single function that attempts to do everything.

Usage

SS_readctl(file, version = NULL, verbose = TRUE, echoall = FALSE,
  nseas = 4, N_areas = 1, Nages = 20, Ngenders = 1,
  Npopbins = NA, Nfleet = 2, Nsurveys = 2, N_tag_groups = NA,
  N_CPUE_obs = NA, use_datlist = FALSE, datlist = NULL,
  ptype = TRUE)

Arguments

file

Filename either with full path or relative to working directory.

version

SS version number. Currently only "3.24" or "3.30" are supported, either as character or numeric values (noting that numeric 3.30 = 3.3).

verbose

Should there be verbose output while running the file? Default=TRUE.

echoall

Debugging tool (not fully implemented) of echoing blocks of data as it is being read.

nseas

number of season in the model. This information is not explicitly available in control file

N_areas

number of spatial areas in the model. This information is also not explicitly available in control file

Nages

oldest age in the model. This information is also not explicitly available in control file

Ngenders

number of genders in the model. This information is also not explicitly available in control file

Npopbins

number of population bins in the model. This information is also not explicitly available in control file and this information is only required if length based maturity vector is directly supplied (Maturity option of 6), and not yet tested

Nfleet

number of fisheries in the model. This information is also not explicitly available in control file

Nsurveys

number of survey fleets in the model. This information is also not explicitly available in control file

N_tag_groups

number of tag release groups in the model. This information is also not explicitly available in control file.

N_CPUE_obs

number of CPUE observations.

use_datlist

LOGICAL if TRUE, use datlist to derive parameters which can not be determined from control file

datlist

list or character. if list : produced from SS_writedat or character : file name of dat file.

ptype

include a column in the output indicating parameter type? (Can be useful, but causes problems for SS_writectl.) Only possible to use for 3.24 control files.

See Also

SS_readctl_3.24, SS_readdat, SS_readdat_3.24