plot_criteria: Produce a DiagrammeR plot and show it and/or convert to SVG

Description Usage Arguments Value

View source: R/plot_criteria.R

Description

This renders a plot with the criteria tree. If the 'criteriaTree' object in the 'criteria' object already contains the weights (as can be added with [mdmcda::add_scorerWeights_to_criteriaTree()] or by a call to [mdmcda::scorerWeights_to_profile()] or [mdmda::combine_weights_and_criteria()]), those will be added and used to color the tree and set the edge thicknesses.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
plot_criteria(
  criteria,
  labels = NULL,
  wrapLabels = 60,
  show_weights = TRUE,
  color_nodes = TRUE,
  color_palette = "viridis",
  renderGraph = TRUE,
  returnSVG = FALSE,
  outputFile = NULL,
  ...
)

Arguments

criteria

The criteria object as produced by a call to, for example, [read_criteria_from_xl()]. The object should contain the criteria tree in '$criteriaTree'.

labels

Optionally, labels to apply to the criteria nodes.

wrapLabels

If applying labels, the number of characters to wrap them to.

show_weights

Whether to add the weighs to the labels of the nodes and edges (and potentially colorized the nodes).

color_nodes, color_palette

Whether to use 'DiagrammeR's 'colorize_node_attrs()' function to color the nodes, and if so, which palette to use.

renderGraph

Whether to show the graph.

returnSVG

Whether to return SVG or not. Valid values are 'FALSE', to return the 'DiagrammeR' object; 'TRUE', to return the SVG; and anything that's not logical to return both in a list.

outputFile

If not NULL and pointing to a file in an existing directory, the graph will be exported to this file.

...

Additional arguments are passed to ‘DiagrammeR'’s 'export_graph' function.

Value

Depending on the value of 'returnSVG', a 'DiagrammeR' object;, a character vector with SVG, or both in a list.


Matherion/mdmcda documentation built on Dec. 31, 2020, 3:13 p.m.