table_decision: Create the Executive Summary decision tables. 'rows_to_label'...

In pacific-hake/hake-assessment: Stock Assessment for Pacific Hake

Create the Executive Summary decision tables. rows_to_label and row_labels need changing each year.

Description

Create the Executive Summary decision tables. rows_to_label and row_labels need changing each year.

Usage

table_decision(
  model,
  type = c("biomass", "spr"),
  forecast_inds = seq_along(model$forecasts[[length(model$forecasts)]]),
  rows_to_show = NULL,
  inc_fi_stable_catch = FALSE,
  bold_letters = TRUE,
  digits = 2,
  left_col_cm = 1,
  right_cols_cm = 1,
  font_size = 10,
  header_font_size = 10,
  header_vert_spacing = 12,
  header_vert_scale = 1.2,
  ret_df = FALSE,
  ...
)

Arguments

model	A model, created by create_rds_file()
type	One of biomass or spr
forecast_inds	The indices to use in the forecasts object which itself is an object of the model list
rows_to_show	A vector of letters of rows to show. If NULL, show
inc_fi_stable_catch	Logical. If TRUE, include the two rows of forecasts for fishing intensity equal to 100% and stable catch for the first two years
bold_letters	Logical. If TRUE, the letters labelling each row will be boldface
digits	The number of decimal points to show in the table
left_col_cm	Number of centimeters wide to make the leftmost column. This needs to be changed when the font size is changed
right_cols_cm	Number of centimeters wide to make the 3 rightmost columns wide. This needs to be changed when the font size is changed
font_size	The table data and header font size in points
header_font_size	The font size for the headers only. If NULL, the headers will have the same font size as the table cell data
header_vert_scale	Scale factor to create the vertical spacing value. See header_vert_spacing
ret_df	Logical. If TRUE, return a data frame (tibble()) instead of the kableExtra::kbl().
...	Arguments passed to knitr::kable()
vert_spacing	The vertical spacing between newlines for this font. If NULL this will be calculated as header_font_size * header_vert_scale

Value

An knitr::kable() object

pacific-hake/hake-assessment documentation built on Feb. 26, 2025, 9:49 p.m.