renderReports: Render reports

Description Usage Arguments Details Value

Description

renders reports.

Usage

1
2
3
renderReports(paths = NULL, obj = NULL, numRecent = 15,
  plot1stObs = TRUE, out.dir = getwd(), figures = TRUE, tables = TRUE,
  format = "word_document", clean = FALSE)

Arguments

paths

- vector of paths to model runs, with case names as names (optional)

obj

- object convertible to a list of tcsam2013.resLst objects, with case names as names (optional)

out.dir

- folder for output

figures

- flag (T/F) to create

tables

- flag (T/F) to create

format

- output file format ("word_document","pdf_document", or "html_document")

clean

- flag (T/F) to create

Details

Renders createReport.Tables.Rmd and createReport.Figures.Rmd from the inst/Rmd folder in the rTCAM2013 package. Values for 'paths' and 'obj' should not be given simultaneously. Output files will be TCSAM2013ReportFigures.ext and TCSAM2013ReportTables.ext, where 'ext' is 'pdf' or 'docx', depending on the format chosen.

Value

vector with paths to model results as elements, if paths is not NULL.


wStockhausen/rTCSAM2013 documentation built on May 3, 2019, 7:13 p.m.