get_inputs_ling: get SS input files for a lingcod model

View source: R/get_inputs_ling.R

get_inputs_lingR Documentation

get SS input files for a lingcod model

Description

uses either a directory (relative to the lingcod package base directory) or a model id like "2021.s.001.001" or the combination of year (yr), area (area), run number (num), and sensitivity number (sens) to assemble that id, then returns a list of the results of the ⁠r4ss::SS_read*()⁠ functions for the four model input files.

Usage

get_inputs_ling(
  area = NULL,
  num = NULL,
  sens = 1,
  yr = 2021,
  id = NULL,
  dir = NULL,
  ss_new = FALSE,
  verbose = FALSE
)

Arguments

area

area, initially either "n" or "s" for 2021 models

num

base model number

sens

sensitivity number (assumed 1 if not specified)

yr

model year (assumed 2021 if not specified)

id

model id (like "2021.s.001.001") as an alternative to the combination of inputs area, num, sens, and year

dir

model directory (like "models/2021.s.001.001_new_fleets") as an alternative to either id or the combination of area, num, sense, and yr

ss_new

logical controling choice between .ss_new or standard inputs

verbose

A logical value specifying if output should be printed to the console or not. The default is FALSE, which will suppress messages.

Author(s)

Ian G. Taylor

See Also

get_dir_ling(), write_inputs_ling()

Examples

## Not run: 
  get_inputs_ling(area ="s", num = 1)
  get_inputs_ling(id = "2021.s.001.001")
  get_inputs_ling(dir = "models/2021.s.001.001_new_fleets")

## End(Not run)

iantaylor-NOAA/Lingcod_2021 documentation built on Oct. 30, 2024, 6:42 p.m.