graph: Plot dataflow graph from R code

Description Usage Arguments Value

View source: R/ui.R

Description

Plot dataflow graph from R code

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
graph(
  path_to_file,
  ignore_source = NULL,
  interactive = FALSE,
  focus_node = NULL,
  prune_labels = NULL,
  prune_types = "function",
  label_option = "auto",
  hover_code = "node"
)

Arguments

path_to_file

character: A file path string

ignore_source

character: If not NULL, any file names matching those specified will be ignored in any "source(filename)" within the scripts.

interactive

logical: If TRUE, will use visNetwork for interactivity, otherwise grViz

focus_node

numeric: ID of a node to focus upon. Only the dependencies of the specified node will be shown.

prune_labels

character: If not NULL, any nodes with labels matching those specified will be pruned (i.e., excluded from the plot) although their dependencies will be cascaded.

prune_types

character: Optionally prune nodes based on type (typically "function" and/or "mutate"). Use NULL to override the default of "function".

label_option

character: Either "both", "assign", "function" or "auto" (which uses "assign" for input nodes and "function" for others).

hover_code

character: Either "node", "network", or NULL. If "node", code for the current node will be displayed on hover, all dependent code for "network", and none if NULL.

Value

Returns a rendered data flow graph


dkary/dfgraph documentation built on Dec. 20, 2021, 12:07 a.m.