table_cohort: Create a table of cohort biomass and natural mortality as...

View source: R/table-cohort.R

table_cohortR Documentation

Create a table of cohort biomass and natural mortality as they pass through their life from year to year

Description

Create a table of cohort biomass and natural mortality as they pass through their life from year to year

Usage

table_cohort(
  model,
  cohorts,
  cohort_italics = TRUE,
  cohort_bold = TRUE,
  cohort_underline = TRUE,
  cohort_line_above = TRUE,
  cohort_line_below = TRUE,
  reverse_cohorts = FALSE,
  digits = 1,
  csv_dir = here::here("doc", out_csv_path),
  font_size = 10,
  header_font_size = 10,
  header_vert_spacing = 12,
  header_vert_scale = 1.2,
  ...
)

Arguments

model

A model, created by create_rds_file()

cohorts

A vector of cohorts (years of birth) to use

cohort_italics

Logical. If TRUE, make the cohort header lines italicized

cohort_bold

Logical. If TRUE, make the cohort header lines boldface

cohort_underline

Logical. If TRUE, make the cohort header lines underlined

cohort_line_above

Logical. If TRUE, place a horizontal line above cohort header lines

cohort_line_below

Logical. If TRUE, place a horizontal line below cohort header lines

reverse_cohorts

Logical. If TRUE, show the cohorts in the table in descending order, with the most recent cohort at the top of the table

digits

Number of decimal points to show in values in the table

csv_dir

Directory for CSV output

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()

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.