quarto_render {quarto} | R Documentation |
Render Markdown
Description
Render the input file to the specified output format using quarto. If the input requires computations (e.g. for Rmd or Jupyter files) then those computations are performed before rendering.
Usage
quarto_render(
input = NULL,
output_format = NULL,
output_file = NULL,
execute = TRUE,
execute_params = NULL,
execute_dir = NULL,
execute_daemon = NULL,
execute_daemon_restart = FALSE,
execute_debug = FALSE,
use_freezer = FALSE,
cache = NULL,
cache_refresh = FALSE,
metadata = NULL,
metadata_file = NULL,
debug = FALSE,
quiet = FALSE,
profile = NULL,
quarto_args = NULL,
pandoc_args = NULL,
as_job = getOption("quarto.render_as_job", "auto")
)
Arguments
input |
The input file or project directory to be rendered (defaults to rendering the project in the current working directory). |
output_format |
Target output format (defaults to |
output_file |
The name of the output file. If using |
execute |
Whether to execute embedded code chunks. |
execute_params |
A list of named parameters that override custom params specified within the YAML front-matter. |
execute_dir |
The working directory in which to execute embedded code chunks. |
execute_daemon |
Keep Jupyter kernel alive (defaults to 300 seconds). Note this option is only applicable for rendering Jupyter notebooks or Jupyter markdown. |
execute_daemon_restart |
Restart keepalive Jupyter kernel before render. Note this option is only applicable for rendering Jupyter notebooks or Jupyter markdown. |
execute_debug |
Show debug output for Jupyter kernel. |
use_freezer |
Force use of frozen computations for an incremental file render. |
cache |
Cache execution output (uses knitr cache and jupyter-cache respectively for Rmd and Jupyter input files). |
cache_refresh |
Force refresh of execution cache. |
metadata |
An optional named list used to override YAML
metadata. It will be passed as a YAML file to |
metadata_file |
A yaml file passed to |
debug |
Leave intermediate files in place after render. |
quiet |
Suppress warning and other messages. |
profile |
Quarto project profile(s) to use. Either
a character vector of profile names or |
quarto_args |
Character vector of other |
pandoc_args |
Additional command line arguments to pass on to Pandoc. |
as_job |
Render as an RStudio background job. Default is |
Examples
## Not run:
# Render R Markdown
quarto_render("notebook.Rmd")
quarto_render("notebook.Rmd", output_format = "pdf")
# Render Jupyter Notebook
quarto_render("notebook.ipynb")
# Render Jupyter Markdown
quarto_render("notebook.md")
# Override metadata
quarto_render("notebook.Rmd", metadata = list(lang = "fr", execute = list(echo = FALSE)))
## End(Not run)