table_timeseries: Create a 'knitr::kable()' table object

View source: R/table_timeseries.R

table_timeseriesR Documentation

Create a knitr::kable() table object

Description

Create a knitr::kable() table object

Usage

table_timeseries(
  ps = NULL,
  type = "ssb",
  time = "mid",
  ci = c(0.05, 0.5, 0.95),
  decimals = 0,
  by_country = FALSE,
  scen = NULL,
  yr_lim = c(NA_real_, NA_real_),
  inc_mean = TRUE,
  scen_names = NULL,
  format = "latex",
  ...
)

Arguments

ps

A plot setup object as output by setup_mse_plot_objects().

type

One of 'ssb', 'ssb_ssb0', catch', 'aas', 'aac'

time

Either 'beg' for beginning of the year SSB or 'mid' for mid-year SSB. Only used if type is 'ssb' or 'ssb_ssb0'.

ci

A vector of credible interval values. 0.5 must be included if the median is desired.

decimals

The number of decimals to round values to

by_country

If TRUE, a table with country data side-by-side will be produced. If FALSE, a table with aggregated output will be produced

scen

The scenario number to use. This is an integer representing the names given by names(ps$sim_data)

yr_lim

A vector of 2 for minimum and maximum yrs to include in the table. If either are NA, the limits of the data are used.

inc_mean

If TRUE, include the mean in the table

scen_names

Names to show in the columns for scenarios. You can experiment by shortening names so that the table fits on the page. If NULL, scenario names from the ps object will be used.

format

See knitr::kable()

...

Arguments passed to knitr::kable()

Value

a knitr::kable() table object


pacific-hake/pacifichakemse documentation built on June 11, 2024, 4:07 a.m.