table_sens: Summarize the configuration of the SS output

In iantaylor-NOAA/Lingcod_2021: Estimate the Status of Lingcod off the US West Coast in 2021

Summarize the configuration of the SS output

Description

Summarize the configuration of the SS output

Usage

table_sens(
  file_csv,
 
    caption = "Differences in likelihood, estimates of key parameters, and estimates of derived quantities between the base model and several alternative models (columns). See main text for details on each sensitivity analysis. Red values indicate negative log likelihoods that were lower than that for the base model.",
  caption_extra = "",
  sens_group = NULL,
  dir = file.path("..", "tables"),
  format = "latex",
  pretty = TRUE
)

Arguments

file_csv	A file path to the csv file.
caption	Text you want in the caption.
caption_extra	Additional text to add after the default caption.
sens_group	Optional description of the group of sensitivities which will be used to change "alternative models" in the caption (if present) to "alternative models related to [sens_group]"
dir	Directory where the table should go (relative to "doc")
format	Argument passed to kableExtra::kbl allowing for the switch between "latex" and "html".
pretty	Logical controlling whether names get cleaned up using internal prettynames() function or not. Setting pretty = FALSE will use utils::read.csv(..., check.names = FALSE).

Examples

## Not run: 
table_sens("tables/sens_table_s_bio_rec.csv")

## End(Not run)

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