writeReport: Function writeReport

writeReportR Documentation

Function writeReport

Description

Generates and renders rmarkdown-documents.

Usage

writeReport(code = list(function() {     library(quantqual)     plotMAT()
      bp()     flowerplot()     spiderplot() }, function() {    
  "Hello world" }),
  intro = c("# Report\nThe research report was generated using the \"quantqual\" package for GNU R."),
  options = "fig.height=7, fig.width=7", author = NULL,
  title = "Research Report", format = "word_document",
  date = "`r Sys.Date()`")

Arguments

code

List of functions containing the code to be documented in the document.

intro

Character vector containing the text to be plotted above each chunk of code.

options

Character vector containing the options to be applied for each chunk of code.

author

Character element specifying the author of the document. Defaults to "'r Sys.Date()'".

title

Character element specifying the document title.

format

Character element specifying the output format (e.g., "word_document", "html_document" or "pdf_document").

date

Character element specifying the date of the document. Defaults to "Mr. X".

Details

Generates and renders rmarkdown-documents.

Examples

writeReport(data.frame(group1=c(variable1=1,variable2=2),group2=c(variable1=3,variable2=4)),horiz=T,main="Example")

AndreasFischer1985/quantqual documentation built on June 20, 2022, 4:55 p.m.