table_param_est: Returns a 'kableExtra::kbl()' containing a comparison of...

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

Returns a kableExtra::kbl() containing a comparison of parameter estimates for all the models in the models list

Description

Returns a kableExtra::kbl() containing a comparison of parameter estimates for all the models in the models list

Usage

table_param_est(
  d = NULL,
  models = NULL,
  model_nms = NULL,
  show_loglike = TRUE,
  section_row_inds = c(1, 11, 20, 21 + length(large_cohorts)),
  section_row_headers = c("Parameters", "Derived Quantities",
    paste0("Reference Points based on ", fspr_40_bold_for_latex_table),
    "Negative log likelihoods"),
  section_italics = TRUE,
  section_bold = TRUE,
  section_underline = TRUE,
  section_line_above = FALSE,
  section_line_below = TRUE,
  digits = 3,
  right_cols_cm = 1.8,
  font_size = 10,
  header_font_size = 10,
  header_vert_spacing = 12,
  header_vert_scale = 1.2,
  longtable = FALSE,
  caption = NULL,
  ...
)

Arguments

models	A list of models which contain the MCMC output
model_nms	A vector of names of the same length as the number of models in the models list
show_loglike	Logical. If TRUE show the negative log likelihood values in the table
section_italics	Logical. If TRUE, make the section header lines italicized
section_bold	Logical. If TRUE, make the section header lines boldface
section_underline	Logical. If TRUE, make the section header lines underlined
section_line_above	Logical. If TRUE, place a horizontal line above section header lines
section_line_below	Logical. If TRUE, place a horizontal line below section header lines
digits	Number of decimal points for the estimates
right_cols_cm	The number of centimeters wide to make all of the rightmost columns (all the value columns)
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
longtable	Logical. Passed to kableExtra::kbl()
caption	The table caption, or NULL for none. Passed to 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 Jan. 14, 2025, 9:12 p.m.