sens_make_table: Make a table of senstivity results

View source: R/sensitivity_output.R

sens_make_tableR Documentation

Make a table of senstivity results

Description

Works with run_sensitivities() and the info in /inst/extdata/sensitivities.csv to make a table of results

Usage

sens_make_table(
  area,
  num,
  sens_base = 1,
  yr = 2021,
  sens_nums,
  sens_mods = NULL,
  sens_names = NULL,
  sens_type = NULL,
  plot = TRUE,
  plot_dir = NULL,
  legendloc = "bottomleft",
  table_dir = "tables",
  write = FALSE,
  ...
)

Arguments

area

Which area "n" or "s"

num

base model number

sens_base

Sensitivity number associated with the base model or source for the other sensitivities.

sens_nums

A vector of values from /inst/extdata/sensitivities.csv

sens_mods

Optional list containing output from multiple models. If present this will skip the reading of the models specified by the inputs above.

sens_names

Optional vector of names for each model to use as headers in the table and legend in the figure (needs to also include the base model)

sens_type

A string indicating the type which is appended to the csv file containing the sensitivity results

plot

Logical for whether to make a two-panel time series plot

plot_dir

Directory for the plot

legendloc

Legend location in plot (as used by r4ss::SSplotComparisons())

table_dir

Directory for the table

write

Logical to write csv file to doc or not

dots

Additional arguments passed to plot_twopanel_comparison()

Author(s)

Ian G. Taylor


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