createLatexForTable.ParamValues.Numbers: Function to print a table of parameters from several models

In wStockhausen/rCompTCMs: Package to compare TCSAM02, rsimTCSAM, and TCSAM2013 model runs

Function to print a table of parameters from several models

Description

This function prints a table of parameters from several models.

Usage

createLatexForTable.ParamValues.Numbers(
  mdfr,
  params = "all",
  fontsize = c("normal", "small"),
  table_type = c("", "longtable"),
  caption = "",
  label = "",
  conn = NULL,
  verbose = FALSE
)

Arguments

mdfr	dataframe from call to extractMDFR.Results.ParameterValues(), filtered for
params	selected parameter names (default = "all")
fontsize	font size (can be 'small')
table_type	latex table type ("" or "longtable")
caption	table caption
label	table label (for cross-referencing)
conn	NULL, "", a filename, or a connection object
verbose	flag (T/F) to print diagnostic information

Details

mdfr should be a dataframe obtained from extractMDFR.Results.ParameterValues(), filtered to include only param_init_numbers and/or param_init_bounded_numbers. The output format for values and standard deviations is 3 significant figures.

NOTE: wtsMarkdown::writeTabularToLatex() is used to create the latex code representing the tabular object. If conn="", the latex code is written to standard output. If conn is a filename or a connection object, the latex code is written to that. If it is NULL, the code is not written to an output device. In all cases, the code is returned as a string, invisibly.

Value

latex text string representing the table (for later insertion into a markdown document)

wStockhausen/rCompTCMs documentation built on Aug. 27, 2024, 7:15 p.m.