Create a SNAPverse satellites flowchart diagram

Save a SNAPverse satellite packages flowchart diagram to disk. The default context = "all" creates a flowchart of all satellite packages. Other options include "utils" and "all", which create flowcharts for the three utils (app, map, and snap) packages and the SNAPverse development packages (meta and site), respectively. If selected is not NULL, selected packages are given a fixed color and any unselected are gray. If NULL, each context group is colored uniquely. Other arguments are passed to DiagrammeR::export_graph.

chart_satellites(file_name, context = "all", selected = NULL,
  file_type = NULL, title = NULL, width = 350, height = NULL)

Arguments

file_name

output file name, defaults to "sv_td_all.svg" for a topdown chart of the full verse.
context

character, all statellites, utils packages only, or dev packages. See details.
selected

character, vector of any selected packages intended to be highlighted vs. others. See details.
file_type

the output file type.
title

character, flowchart title.
width

numeric.
height

numeric.

Value

side effect of saving image file to disk.

Examples

# NOT RUN {
chart_satellites(file_name = "sv_satellites_all.svg",
  context = "all", title = "SNAPverse satellite packages")
chart_satellites(file_name = "sv_satellites_utils.svg",
  context = "utils", title = "SNAPverse utils satellites")
chart_satellites(file_name = "sv_satellites_utils_app.svg",
  context = "utils", selected = "apputils",
  title = "SNAPverse utils satellites")
chart_satellites(file_name = "sv_satellites_dev.svg",
  context = "dev", title = "SNAPverse development satellites")
# }