Reporting with Pandoc
This R5
reference class can hold bunch of elements (text or R objects) from which it tries to create a Pandoc's markdown text file. Exporting the report to several formats (like: PDF, docx, odt etc. - see Pandoc's documentation) is also possible, see examples below.
... |
this is an R5 object without any direct params but it should be documented, right? |
export(Class)
Returns the result of coercing the object to Class. No effect on the object itself.
## Not run: ## Initialize a new Pandoc object myReport <- Pandoc$new() ## Add author, title and date of document myReport$author <- 'Anonymous' myReport$title <- 'Demo' ## Or it could be done while initializing myReport <- Pandoc$new('Anonymous', 'Demo') ## Add some free text myReport$add.paragraph('Hello there, this is a really short tutorial!') ## Add maybe a header for later stuff myReport$add.paragraph('# Showing some raw R objects below') ## Adding a short matrix myReport$add(matrix(5,5,5)) ## Or a table with even # TODO: caption myReport$add.paragraph('Hello table:') myReport$add(table(mtcars$am, mtcars$gear)) ## Or a "large" data frame which barely fits on a page myReport$add(mtcars) ## And a simple linear model with Anova tables ml <- with(lm(mpg ~ hp + wt), data = mtcars) myReport$add(ml) myReport$add(anova(ml)) myReport$add(aov(ml)) ## And do some principal component analysis at last myReport$add(prcomp(USArrests)) ## Sorry, I did not show how Pandoc deals with plots: myReport$add(plot(1:10)) # TODO: caption ## Want to see the report? Just print it: myReport ## Exporting to PDF (default) myReport$export() ## Or to docx in tempdir: myReport$format <- 'docx' myReport$export(tempfile()) ## You do not want to see the generated report after generation? myReport$export(open = FALSE) ## End(Not run)
Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.