table_biomass: Create a table of spawning biomass and relative spawning...

View source: R/table-biomass.R

table_biomassR Documentation

Create a table of spawning biomass and relative spawning biomass medians and quantiles

Description

Create a table of spawning biomass and relative spawning biomass medians and quantiles

Creates a table summarizing lead parameters

Usage

table_biomass(
  model,
  start_yr,
  end_yr,
  digits = 1,
  scale = 1000,
  font_size = 8,
  header_font_size = 10,
  header_vert_spacing = 12,
  header_vert_scale = 1.2,
  ...
)

table_param_est_bounds(
  model,
  start_rec_dev_yr,
  end_rec_dev_yr,
  section_sep_lines = FALSE,
  digits = 2,
  font_size = 8,
  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()

start_yr

Start year in table

end_yr

End year in table

digits

Number of decimal places to round to

scale

A scale factor to divide the biomass by

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

...

Arguments passed to knitr::kable()

start_rec_dev_yr

First year of estimated recruitment devs

end_rec_dev_yr

Last year of estimated recruitment devs

section_sep_lines

Logical. If TRUE, place a line under the sections in each cell as a way to separate them vertically from the years above and below

ret_df

If TRUE, return a data frame of the results, if FALSE, return a kableExtra::kbl() table

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

Either a tibble::tibble() or kableExtra::kbl() object


pacific-hake/hake-assessment documentation built on Jan. 14, 2025, 9:12 p.m.