renderTaskQmd: Render the task from the Qmd file

In D4TAlink.light: GDP - Workflow Management

Render the task from the Qmd file

Description

The template of the task is rendered towards pdf or html in the documentation directory of the specified task. Note that on windows, Gnu zip may be required. The path to the executable must be added to the environment variables.

Usage

renderTaskQmd(task, output_format = "docx", debug = FALSE, suffix = NA, ...)

Arguments

task	Object of class D4TAlinkTask, as created by initTask.
output_format	Target output format (defaults to "html"). The option "all" will render all formats defined within the file or project.
debug	if TRUE execute in the global environment.
suffix	Filename suffix, used to develop scripts for sub-analyses for a given task, default NA.
...	Arguments passed on to quarto::quarto_render input The input file or project directory to be rendered (defaults to rendering the project in the current working directory). output_file Base name for single-file output (e.g. PDF, ePub, MS Word). This sets the output-file Quarto metadata. If NULL, the output filename will be based on the input filename. 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 CLI flag. This will be merged over metadata-file options if both are specified. metadata_file A yaml file passed to --metadata-file CLI flags to override metadata. This will be merged with metadata if both are specified, with low precedence on metadata options. quiet Suppress warning and other messages, from R and also Quarto CLI (i.e --quiet is passed as command line). quarto.quiet R option or R_QUARTO_QUIET environment variable can be used to globally override a function call (This can be useful to debug tool that calls ⁠quarto_*⁠ functions directly). On Github Actions, it will always be quiet = FALSE. profile Quarto project profile(s) to use. Either a character vector of profile names or NULL to use the default profile. quarto_args Character vector of other quarto CLI arguments to append to the Quarto command executed by this function. This is mainly intended for advanced usage and useful for CLI arguments which are not yet mirrored in a dedicated parameter of this R function. See ⁠quarto render --help⁠ for options. pandoc_args Additional command line arguments to pass on to Pandoc. as_job Render as an RStudio background job. Default is "auto", which will render individual documents normally and projects as background jobs. Use the quarto.render_as_job R option to control the default globally.

Value

the file name invisibly.

D4TAlink.light documentation built on Sept. 11, 2025, 1:07 a.m.