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

View source: R/table_perf_metrics.R

table_perf_metricsR Documentation

Create a knitr::kable() table object

Description

Create a knitr::kable() table object

Usage

table_perf_metrics(
  ps,
  ci = c(0.05, 0.5, 0.95),
  decimals = 0,
  scen = NULL,
  inc_mean = TRUE,
  scen_names = NULL,
  format = "latex",
  ...
)

Arguments

ps

A plot setup object as output by setup_mse_plot_objects().

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

scen

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

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.