1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
#' Reporting with Pandoc
#'
#' This \code{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.
#' @param ... this is an R5 object without any direct params but it should be documented, right?
#' @export Pandoc
#' @examples \dontrun{
#' ## 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)
#' }
#' @importFrom methods setRefClass new getGeneric
Pandoc <- setRefClass('Pandoc', fields = list('author' = 'character',
'title' = 'character',
'date' = 'character',
'body' = 'list',
'format' = 'character',
'proc.time' = 'numeric'))
Pandoc$methods(initialize = function(author = 'Anonymous',
title = base::sprintf('%s\'s report', author),
date = base::date(),
format = 'pdf', ...) {
.self$author <- author
.self$title <- title
.self$date <- date
.self$format <- format
.self$proc.time <- 0
callSuper(...)
})
Pandoc$methods(add = function(x) {
timer <- proc.time()
res <- evals(deparse(match.call()[[2]]),
env = parent.frame(),
graph.name = evalsOptions('graph.name'),
graph.dir = evalsOptions('graph.dir'),
graph.output = evalsOptions('graph.output'),
width = evalsOptions('width'),
height = evalsOptions('height'))
.self$body <- c(.self$body, res)
.self$proc.time <- .self$proc.time + as.numeric(proc.time() - timer)[3]
})
Pandoc$methods(add.paragraph = function(x) .self$body <- c(.self$body, list(list(result = pandoc.p.return(x)))))
Pandoc$methods(show = function(x) {
## starting timer for proc.time
timer <- proc.time()
## show header
cat(pandoc.header(.self$title, style = 'setext'))
cat(' written by *', .self$author, '* at *', .self$date, '*\n', sep = '')
cat('\n', sprintf(' This report holds %s block(s).', length(.self$body)), '\n')
## show body (if not empty)
if (length(.self$body) > 0) {
cat(pandoc.horizontal.rule())
lapply(.self$body, function(x) {
for (m in c('messages', 'warnings', 'errors')) {
if (!is.null(x$msg[[m]])) {
cat('\n**', toupper(sub('s$', '', m)), ':** ', x$msg[[m]], sep = '')
}
}
pander(x$result)
})
## show proc.time
cat(pandoc.horizontal.rule())
cat('\nProc. time: ', .self$proc.time + as.numeric(proc.time() - timer)[3], 'seconds. \n\n')
} else {
cat('\n)')
}
})
Pandoc$methods(export = function(f, ...) {
if (missing(f)) {
f <- tempfile('pander-', getwd())
}
fp <- sprintf('%s.md', f)
timer <- proc.time()
## create pandoc file
cat(pandoc.title.return(.self$title, .self$author, .self$date), file = fp)
lapply(.self$body,
function(x) cat(paste(capture.output(pander(x$result)), collapse = '\n'), file = fp, append = TRUE))
## convert
fe <- Pandoc.convert(fp, format = .self$format, proc.time = as.numeric(proc.time() - timer)[3], ...)
## return
cat('\nExported to *', f, '.[md|', format, ']* under ',
.self$proc.time + as.numeric(proc.time() - timer)[3], ' seconds.\n\n', sep = '')
return(invisible(fe))
})
|
