make_diagram: Create workflow diagram

In cramirezs/wreportr: Summarise Your Folders

Description

make_diagram creates a

Usage

make_diagram(
  report_file = knitr::current_input(dir = TRUE),
  critical = list(names = "lustering|uality", color = "Gold"),
  exclude = "libraries",
  style = "single-cell",
  extra_connections = NULL,
  critical_connections = NULL,
  central_node = "",
  last_node = ""
)

Arguments

report_file	Step's list or Reportr object, Default: knitr::current_input(dir = TRUE).
critical	Critical steps, Default: list(names = "lustering|uality", color = "Gold").
exclude	Exclude these steps, Default: 'libraries'.
style	Style has a pre-set of connections between steps, Default: 'single-cell'.
extra_connections	This further modifies connections, Default: NULL.
critical_connections	Makes the connection red, Default: NULL.
central_node	Step connected to the rest after it, Default: ”.
last_node	Last step in the diagram, Default: ”.

Details

At the moment is more difficult to get the right titles from a list or an Reportr object

Value

Spec for a Graphviz diagram as text.

See Also

current_input

Examples

## Not run: 
 if(interactive()){
  DiagrammeR::grViz(make_diagram(list("Step1"= 1, "Step2" = 2), style = NULL))
 }

## End(Not run)

cramirezs/wreportr documentation built on Dec. 19, 2021, 6:09 p.m.