Generate OM Documentation Report
OMdoc(
OM = NULL,
rmd.source = NULL,
overwrite = FALSE,
out.file = NULL,
inc.plot = TRUE,
render = TRUE,
output = "html_document",
openFile = TRUE,
quiet = FALSE,
dir = NULL,
...
)
An object of class 'OM' or the name of an OM xlsx file
Optional. Name of the source.rmd file corresponding to the 'OM'. Default assumption is that the file is 'OM@Name.Rmd'
Logical. Should existing files be overwritten?
Optional. Character. Name of the output file. Default is the same as the text file.
Logical. Should the plots be included?
Logical. Should the document be compiled? May be useful to turn off if there are problems with compiling the Rmd file.
Character. Output file type. Default is 'html_document'. 'pdf_document' is available but may require additional software and have some formatting issues.
Logical. Should the compiled file be opened in web browser?
TRUE to suppress printing of the pandoc command line.
Optional file path to read the xlsx and rmd files. Default is getwd()
Optional additional named arguments provided to runMSE
Creates a Rmarkdown file and compiles a HTML report file in the working directory.