writeReport: Creates a report with plots.

Usage Arguments Value

Usage

1
2
3
4
writeReport(dmObj = NULL, dmObj.RData.file = NULL,
  output.file = "report1", rav.options = list(),
  output.format = c("pdf_document"), output.dir = getwd(),
  input.type = "xRnw")

Arguments

dmObj

a saved DM object (list) from runModel() with the objects "input","dat","result", and "tDat"

dmObj.RData.file

a saved DM object as a RData file with the objects "input","dat","result", and "tDat"

output.file

Filename to give saved report.

rav.options

list of the rav file options to use that do not come from the posteriors.

output.format

list of output formats. If input.type=="xRmd", any format that rmarkdown:::render allows is fine. If input.type=="xRnw", only "pdf_document" is allowed.

output.dir

Directory where to save the output files. Defaults to working directory.

input.type

xRmd for rmarkdown. xRnw for knitr.

Value

Nothing. The report is written to a PDF and tex file.


eeholmes/DM documentation built on May 26, 2019, 3:36 p.m.