render_book {bookdown} | R Documentation |
Render multiple R Markdown files under the current working directory into a
book. It can be used in the RStudio IDE (specifically, the knit
field
in YAML). The preview_chapter()
function is a wrapper of
render_book(preview = TRUE)
.
render_book( input, output_format = NULL, ..., clean = TRUE, envir = parent.frame(), clean_envir = !interactive(), output_dir = NULL, new_session = NA, preview = FALSE, config_file = "_bookdown.yml" ) preview_chapter(..., envir = parent.frame())
input |
An input filename (or multiple filenames). If |
output_format, ..., clean, envir |
Arguments to be passed to
|
clean_envir |
Whether to clean up the environment |
output_dir |
The output directory. If |
new_session |
Whether to use new R sessions to compile individual Rmd
files (if not provided, the value of the |
preview |
Whether to render and preview the input files specified by the
|
config_file |
The book configuration file. |
There are two ways to render a book from Rmd files. The default way
(new_session = FALSE
) is to merge Rmd files into a single file and
render this file. You can also choose to render each individual Rmd file in a
new R session (new_session = TRUE
).
# see https://bookdown.org/yihui/bookdown for the full documentation if (file.exists("index.Rmd")) bookdown::render_book("index.Rmd")