printResults.ParameterValues: Function to print a table of parameters from several models

View source: R/printResults.ParameterValues.R

printResults.ParameterValuesR Documentation

Function to print a table of parameters from several models

Description

This function prints a table of parameters from several models.

Usage

printResults.ParameterValues(
  objs = NULL,
  mdfr = NULL,
  categories = "all",
  processes = "all",
  types = "all",
  params = "all",
  format = c("latex", "docx"),
  landscape = FALSE,
  fontsize = "11pt",
  verbose = FALSE
)

Arguments

objs
  • list of resLst objects

mdfr
  • dataframe from call to extractMDFR.Results.ParameterValues() (as alternative to objs)

categories
  • default = "all"

processes
  • default = "all"

types
  • default = "all"

params
  • selected parameter names (default = "all")

format
  • 'latex' or 'docx'

landscape
  • flag indicating whether page orientation is landscape or portrait

fontsize
  • font size (can be 'small')

verbose
  • flag (T/F) to print diagnostic information

Details

Uses extractMDFR.Results.ParameterValues() to get a dataframe of parameters. If format="latex", the package tables is used to create and print a table in latex format. Output format for values and standard deviations is 3 significant figures.

Specific tables can be created/selected by specifying non-default values for categories, processes, types, and params.

Value

ggplot2 object


wStockhausen/rCompTCMs documentation built on Sept. 12, 2023, 3:13 p.m.