Skip to contents

Choose Interactively What `render_pipeline()` Renders

Source: R/interactive_render_pipeline.R
interactive_render_pipeline.Rd

A menu in front of [render_pipeline()] for an interactive R session: it lists the documents of the pipeline in render order ([get_render_plan()]) and asks whether to render the stale ones, everything again, everything up to one document, or one document only. For a script or any non-interactive session use [render_pipeline()] itself.

Usage

interactive_render_pipeline(all_file_objects, ...)

Arguments

all_file_objects

The list of `FilePath`, `FileUses` and `FileOutputs` objects that [render_pipeline()] takes as `path`.

...

Further arguments for [render_pipeline()] (`formats`, `workers`, `on_error`, ...). `path`, `only_stale`, `rerun`, `from` and `to` are set by the menu and may not be given here.

Value

The data frame that [render_pipeline()] returns, invisibly; `NULL` if cancelled.

Details

The choices: 1. **Render all stale documents**: `only_stale = TRUE`. 2. **Render all (force rerun)**: `rerun = "full"`, i.e. `only_stale = FALSE` and `cache = "refresh"`. 3. **Render up to an item**: asks for a number or a name from the list, then `to = item`. 4. **Render a single item**: asks for a number or a name, then `from = item, to = item`. 5. **Cancel**: nothing is rendered.

Closing the menu without a choice cancels too. A number or name that is not in the list is an error; nothing is rendered.

See also

[render_pipeline()], [get_render_plan()]

Examples

if (FALSE) { # \dontrun{
interactive_render_pipeline(all_file_objects, formats = "html", workers = 4)
} # }