get_dir_ling: get directory for a lingcod model

View source: R/get_dir_ling.R

get_dir_lingR Documentation

get directory for a lingcod model

Description

uses either 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 the associated directory based on the table in the models/README.md

Usage

get_dir_ling(
  area = NULL,
  num = NULL,
  sens = 1,
  yr = 2021,
  id = NULL,
  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

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, Kelli Faye Johnson

See Also

get_inputs_ling()

Examples

## Not run: 
  get_dir_ling(area ="s", num = 1)
  get_dir_ling(id = "2021.s.001.001")

## End(Not run)

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