blob: 80e36a29468ec02ed0f5453cdcf6ee14ab63a7a7 [file] [log] [blame]
JJ Allaire2ec40242014-09-15 09:18:39 -04001#' Convert to a reveal.js presentation
JJ Allaire4c178052016-01-30 19:35:39 -05002#'
JJ Allaire2ec40242014-09-15 09:18:39 -04003#' Format for converting from R Markdown to a reveal.js presentation.
JJ Allaire4c178052016-01-30 19:35:39 -05004#'
JJ Allaire2ec40242014-09-15 09:18:39 -04005#' @inheritParams rmarkdown::beamer_presentation
6#' @inheritParams rmarkdown::pdf_document
7#' @inheritParams rmarkdown::html_document
JJ Allaire4c178052016-01-30 19:35:39 -05008#'
JJ Allaire2ec40242014-09-15 09:18:39 -04009#' @param center \code{TRUE} to vertically center content on slides
JJ Allaire4c178052016-01-30 19:35:39 -050010#' @param slide_level Level of heading to denote individual slides. If
11#' \code{slide_level} is 2 (the default), a two-dimensional layout will be
12#' produced, with level 1 headers building horizontally and level 2 headers
13#' building vertically. It is not recommended that you use deeper nesting of
14#' section levels with reveal.js.
15#' @param theme Visual theme ("simple", "sky", "beige", "serif", "solarized",
16#' "blood", "moon", "night", "black", "league" or "white").
junkkad4b3a162015-03-16 07:49:11 +010017#' @param transition Slide transition ("default", "none", "fade", "slide",
18#' "convex", "concave" or "zoom")
JJ Allaire4c178052016-01-30 19:35:39 -050019#' @param background_transition Slide background-transition ("default", "none",
20#' "fade", "slide", "convex", "concave" or "zoom")
21#' @param reveal_options Additional options to specify for reveal.js (see
22#' \href{https://github.com/hakimel/reveal.js#configuration}{https://github.com/hakimel/reveal.js#configuration}
23#' for details).
24#' @param template Pandoc template to use for rendering. Pass "default" to use
25#' the rmarkdown package default template; pass \code{NULL} to use pandoc's
26#' built-in template; pass a path to use a custom template that you've
27#' created. Note that if you don't use the "default" template then some
28#' features of \code{revealjs_presentation} won't be available (see the
29#' Templates section below for more details).
JJ Allaire8d1c2f42016-01-30 14:56:45 -050030#' @param ... Ignored
JJ Allaire4c178052016-01-30 19:35:39 -050031#'
JJ Allaire2ec40242014-09-15 09:18:39 -040032#' @return R Markdown output format to pass to \code{\link{render}}
JJ Allaire4c178052016-01-30 19:35:39 -050033#'
JJ Allaire2ec40242014-09-15 09:18:39 -040034#' @details
JJ Allaire309bc7d2016-01-30 19:17:54 -050035#'
JJ Allaire4c178052016-01-30 19:35:39 -050036#' In reveal.js presentations you can use level 1 or level 2 headers for slides.
37#' If you use a mix of level 1 and level 2 headers then a two-dimensional layout
38#' will be produced, with level 1 headers building horizontally and level 2
39#' headers building vertically.
40#'
41#' For additional documentation on using revealjs presentations see
42#' \href{https://github.com/rstudio/revealjs}{https://github.com/rstudio/revealjs}.
JJ Allaire4c178052016-01-30 19:35:39 -050043#'
JJ Allaire2ec40242014-09-15 09:18:39 -040044#' @examples
45#' \dontrun{
JJ Allaire4c178052016-01-30 19:35:39 -050046#'
JJ Allaire2ec40242014-09-15 09:18:39 -040047#' library(rmarkdown)
48#' library(revealjs)
JJ Allaire4c178052016-01-30 19:35:39 -050049#'
JJ Allaire2ec40242014-09-15 09:18:39 -040050#' # simple invocation
51#' render("pres.Rmd", revealjs_presentation())
JJ Allaire4c178052016-01-30 19:35:39 -050052#'
JJ Allaire2ec40242014-09-15 09:18:39 -040053#' # specify an option for incremental rendering
54#' render("pres.Rmd", revealjs_presentation(incremental = TRUE))
55#' }
JJ Allaire4c178052016-01-30 19:35:39 -050056#'
57#'
JJ Allaire2ec40242014-09-15 09:18:39 -040058#' @export
59revealjs_presentation <- function(incremental = FALSE,
60 center = FALSE,
JJ Allaire4c178052016-01-30 19:35:39 -050061 slide_level = 2,
JJ Allaire2ec40242014-09-15 09:18:39 -040062 fig_width = 8,
63 fig_height = 6,
64 fig_retina = if (!fig_caption) 2,
65 fig_caption = FALSE,
66 smart = TRUE,
67 self_contained = TRUE,
JJ Allaire6da1bb62016-01-30 14:28:39 -050068 theme = "simple",
JJ Allaire2ec40242014-09-15 09:18:39 -040069 transition = "default",
junkkad55cff02015-03-15 22:27:03 +010070 background_transition = "default",
JJ Allaire37f45b72016-01-30 18:17:45 -050071 reveal_options = NULL,
JJ Allaire2ec40242014-09-15 09:18:39 -040072 highlight = "default",
73 mathjax = "default",
74 template = "default",
JJ Allairefad55232015-10-19 07:47:26 -040075 css = NULL,
JJ Allaire2ec40242014-09-15 09:18:39 -040076 includes = NULL,
77 keep_md = FALSE,
78 lib_dir = NULL,
79 pandoc_args = NULL,
80 ...) {
81
82 # function to lookup reveal resource
83 reveal_resources <- function() {
JJ Allaire2d8f3f22016-01-30 13:08:52 -050084 system.file("rmarkdown/templates/revealjs_presentation/resources",
JJ Allaire2ec40242014-09-15 09:18:39 -040085 package = "revealjs")
86 }
87
88 # base pandoc options for all reveal.js output
89 args <- c()
90
91 # template path and assets
JJ Allairea8c414b2016-01-30 14:36:53 -050092 if (identical(template, "default")) {
93 default_template <- system.file(
94 "rmarkdown/templates/revealjs_presentation/resources/default.html",
95 package = "revealjs"
96 )
97 args <- c(args, "--template", pandoc_path_arg(default_template))
98 } else if (!is.null(template)) {
JJ Allaire2ec40242014-09-15 09:18:39 -040099 args <- c(args, "--template", pandoc_path_arg(template))
JJ Allairea8c414b2016-01-30 14:36:53 -0500100 }
JJ Allaire2ec40242014-09-15 09:18:39 -0400101
102 # incremental
103 if (incremental)
104 args <- c(args, "--incremental")
105
106 # centering
JJ Allaire40fec332016-01-30 16:54:51 -0500107 jsbool <- function(value) ifelse(value, "true", "false")
108 args <- c(args, pandoc_variable_arg("center", jsbool(center)))
JJ Allaire2ec40242014-09-15 09:18:39 -0400109
JJ Allaire4c178052016-01-30 19:35:39 -0500110 # slide level
111 args <- c(args, "--slide-level", "2")
112
JJ Allaire2ec40242014-09-15 09:18:39 -0400113 # theme
114 theme <- match.arg(theme, revealjs_themes())
115 if (identical(theme, "default"))
116 theme <- "simple"
117 else if (identical(theme, "dark"))
JJ Allaire6da1bb62016-01-30 14:28:39 -0500118 theme <- "black"
119 if (theme %in% c("blood", "moon", "night", "black"))
JJ Allaire2ec40242014-09-15 09:18:39 -0400120 args <- c(args, "--variable", "theme-dark")
121 args <- c(args, "--variable", paste("theme=", theme, sep=""))
122
123
124 # transition
125 transition <- match.arg(transition, revealjs_transitions())
126 args <- c(args, "--variable", paste("transition=", transition, sep=""))
127
junkkad55cff02015-03-15 22:27:03 +0100128 # background_transition
129 background_transition <- match.arg(background_transition, revealjs_transitions())
JJ Allaire40fec332016-01-30 16:54:51 -0500130 args <- c(args, "--variable", paste("backgroundTransition=", background_transition, sep=""))
131
JJ Allaire37f45b72016-01-30 18:17:45 -0500132 # additional reveal options
133 if (is.list(reveal_options)) {
134 for (option in names(reveal_options)) {
135 value <- reveal_options[[option]]
136 if (is.logical(value))
137 value <- jsbool(value)
138 args <- c(args, pandoc_variable_arg(option, value))
139 }
140 }
141
JJ Allaire2ec40242014-09-15 09:18:39 -0400142 # content includes
143 args <- c(args, includes_to_pandoc_args(includes))
144
JJ Allairefad55232015-10-19 07:47:26 -0400145 # additional css
146 for (css_file in css)
147 args <- c(args, "--css", pandoc_path_arg(css_file))
148
JJ Allaire2ec40242014-09-15 09:18:39 -0400149 # pre-processor for arguments that may depend on the name of the
150 # the input file (e.g. ones that need to copy supporting files)
151 pre_processor <- function(metadata, input_file, runtime, knit_meta, files_dir,
152 output_dir) {
153
JJ Allairee60feb22016-01-30 18:28:47 -0500154 # we don't work with runtime shiny
155 if (identical(runtime, "shiny")) {
156 stop("revealjs_presentation is not compatible with runtime 'shiny'",
157 call. = FALSE)
158 }
159
JJ Allaire2ec40242014-09-15 09:18:39 -0400160 # use files_dir as lib_dir if not explicitly specified
161 if (is.null(lib_dir))
162 lib_dir <- files_dir
163
164 # extra args
165 args <- c()
166
167 # reveal.js
JJ Allairea8c414b2016-01-30 14:36:53 -0500168 revealjs_path <- system.file("reveal.js-3.2.0", package = "revealjs")
JJ Allaire2ec40242014-09-15 09:18:39 -0400169 if (!self_contained || identical(.Platform$OS.type, "windows"))
170 revealjs_path <- relative_to(
171 output_dir, render_supporting_files(revealjs_path, lib_dir))
172 args <- c(args, "--variable", paste("revealjs-url=",
173 pandoc_path_arg(revealjs_path), sep=""))
174
175 # highlight
176 args <- c(args, pandoc_highlight_args(highlight, default = "pygments"))
177
178 # return additional args
179 args
180 }
181
182 # return format
183 output_format(
184 knitr = knitr_options_html(fig_width, fig_height, fig_retina, keep_md),
185 pandoc = pandoc_options(to = "revealjs",
186 from = rmarkdown_format(ifelse(fig_caption,
187 "",
188 "-implicit_figures")),
189 args = args),
190 keep_md = keep_md,
191 clean_supporting = self_contained,
192 pre_processor = pre_processor,
193 base_format = html_document_base(smart = smart, lib_dir = lib_dir,
194 self_contained = self_contained,
195 mathjax = mathjax,
196 pandoc_args = pandoc_args, ...))
197}
198
199revealjs_themes <- function() {
200 c("default",
JJ Allaire6da1bb62016-01-30 14:28:39 -0500201 "dark",
JJ Allaire2ec40242014-09-15 09:18:39 -0400202 "simple",
203 "sky",
204 "beige",
205 "serif",
206 "solarized",
JJ Allaire2ec40242014-09-15 09:18:39 -0400207 "blood",
208 "moon",
junkka77fbf082015-03-15 22:25:47 +0100209 "night",
210 "black",
211 "league",
212 "white")
JJ Allaire2ec40242014-09-15 09:18:39 -0400213}
214
215
216revealjs_transitions <- function() {
junkka77fbf082015-03-15 22:25:47 +0100217 c(
218 "default",
219 "none",
JJ Allaire2ec40242014-09-15 09:18:39 -0400220 "fade",
junkka77fbf082015-03-15 22:25:47 +0100221 "slide",
222 "convex",
223 "concave",
224 "zoom"
225 )
JJ Allaire2ec40242014-09-15 09:18:39 -0400226}
227
228