graph_flow: Create a graph with Flow objects hierarchy

View source: R/graph_flow.R

graph_flowR Documentation

Create a graph with Flow objects hierarchy

Description

A graph showing all Flow objects heritage is calculated, and displayed.

Usage

graph_flow(env = .GlobalEnv, child_to_parent = TRUE, plotit = TRUE, ...)

Arguments

env

The environment to look for Flow objects. By default, it is .GlobalEnv, and you should not change it, since all Flow objects are derived from it by construction.

child_to_parent

Do the arrows go from child to parent (by default), or in the other direction?

plotit

Do we plot the graph (by default)?

...

Further parameters passed to plot.igraph().

Value

An igraph object (returned invisibly if plotit = TRUE.

See Also

flow

Examples

a <- flow()
b <- a$flow()
c <- b$flow()
d <- a$flow()
# Use of custom names
e <- flow(.name = "parent")
f <- e$flow(.name = "child")
graph_flow()

# Arrows pointing from childs to parents, and do not plot it
g <- graph_flow(child_to_parent = FALSE, plotit = FALSE)
g
plot(g)

SciViews/flow documentation built on May 4, 2024, 6:22 a.m.