plotTCSAM2015: Plot TCSAM2015 model output

Description Usage Arguments Details Value

View source: R/plotTCSAM2015.R

Description

Function to plot data and results from a TCSAM2015 model run.

Usage

1
2
3
plotTCSAM2015(repObj = NULL, prsObj = NULL, stdObj = NULL,
  objList = NULL, ggtheme = theme_grey(), showPlot = TRUE, pdf = NULL,
  width = 14, height = 8, verbose = FALSE)

Arguments

repObj

- tcsam2015.rep list object based on sourcing a TCSAM2015 model report file. can be NULL or a filename.

prsObj

- tcsam2015.prs dataframe object based on reading TCSAM2015 parameters csv files. can be 'active' or 'all', as well.

stdObj

- tcsam2015.std dataframe object based on reading a TCSAM2015 std file. can be NULL or a filename.

objList

- list with optional elements repObj, prsObj, stdObj (an optional way to provide the Obj's)

ggtheme

- a ggplot2 theme to use with ggplot2 plots

showPlot

- flag to show plots immediately

pdf

- filename for pdf output (optional)

width

- pdf page width (in inches)

height

- pdf page width (in inches)

verbose

- flag (T/F) to print dagnostic info

Details

If repObj is a character string (the path to a report file), the file will be read in. If repObj is NULL, the user will be prompted to identify a model report file from which to source the report object. Similarly for stdObj. prsObj can be 'all' or 'active', but the filenames are inferred. Any of these objects obtained by reading will be an element in the returned list.

Value

list with possible elements:
* repObj - TCSAM2015 report list object (if report file was read) * prsObj - TCSAM2015 parameters dataframe object (if parameters csv file was read) * stdObj - TCSAM2015 std devs dataframe object (if std file was read) * plots: multi-level list of ggplot2 objects


wStockhausen/rTCSAM2015 documentation built on May 3, 2019, 7:14 p.m.