Sankey Diagrams : General parameters in sankey diagrams
# sankeyAxes
Axes to include in the alluvial plots. It must sample annotations of the string type in the x object
Type:
array
Default:
[]
Used in:
Sankey
# sankeyAxesOrder
Object giving an explicit top-to-bottom order for the strata of a Sankey/alluvial column, for this graph only (independent of legendOrder). The key is a sankeyAxes annotation (or the sankeySource/sankeyTarget annotation) and the value is an array of its stratum levels in the desired order; any level not listed is placed last, alphabetically. Setting this implies sankeyNodeSort "factor"
Type:
object
Default:
Used in:
Sankey
sankeyAxesOrder : false
sankeyAxesOrder : {"Group": ["GroupC", "GroupB", "GroupA"]}
# sankeyColorNodesByValue
Flag to colour each Sankey node by its own value (level) rather than by a single colorBy annotation, and to paint every flow ribbon in its source node's colour. Set on the ggsankey (davidsjoberg/ggsankey) path, where fill = factor(node) colours the whole diagram per node
Type:
boolean
Default:
false
Used in:
Sankey
sankeyColorNodesByValue : true
sankeyColorNodesByValue : false
# sankeyLinkLineWidth
Outline width (px) for the Sankey/alluvial flow ribbons. Left null the ribbons use the default outlineWidth, which inflates a thin (low-value) flow into a solid ~1px line in its fill colour; a small value (e.g. 0.25) lets thin flows render at their true width so many overlapping ribbons no longer read as a dense line-mesh
Type:
float
Default:
Used in:
Sankey
sankeyLinkLineWidth : 0.5
sankeyLinkLineWidth : 2
# sankeyLinkOrder
Paint order of the Sankey/alluvial flow ribbons (which overlays which). data (default) keeps the input/build order; color paints them grouped by the colorBy annotation level order and then by alluvium id, so same-coloured ribbons draw together and later ones overlay (ggalluvial z_order_aes parity). Only affects colour-by diagrams
Type:
string
Default:
data
Used in:
Sankey
# sankeyLinksColor
sankeyLinksColor : "#9e0adb"
sankeyLinksColor : "#ff7d00"
# sankeyLinksOpacity
Opacity (0-1) of the Sankey/alluvial link (flow) fills when they are coloured by an annotation (colorBy). The ggplot/alluvial path sets this from the geom_alluvium alpha aesthetic
Type:
float
Default:
0.75
Used in:
Sankey
# sankeyLodeGuidance
Vertical order of the flow ribbons WITHIN each stratum of a Sankey/alluvial (which lode sits above which). none (default) stacks by the neighbouring node position (native). The others port ggalluvial's lode.guidance: within a stratum, alluvia are ordered by the strata they pass through in the OTHER axes, visited in a set priority. zigzag (ggalluvial default) weights the nearest axes first, alternating outward; forward/backward weight earlier/later axes; frontback/backfront sweep to one end then the other. Requires an explicit sankeyNodeSort (e.g. "factor")
Type:
string
Default:
none
Used in:
Sankey
sankeyLodeGuidance : "none"
sankeyLodeGuidance : "zigzag"
sankeyLodeGuidance : "forward"
sankeyLodeGuidance : "backward"
sankeyLodeGuidance : "frontback"
sankeyLodeGuidance : "backfront"
# sankeyNodeLegendTitle
Title of the Sankey node-value legend drawn when sankeyColorNodesByValue and sankeyNodeColorMap are set. The ggsankey path sets it to the fill aesthetic label (e.g. "factor(node)"). Set false to draw the legend with no title
Type:
string
Default:
Used in:
Sankey
sankeyNodeLegendTitle : "Node"
sankeyNodeLegendTitle : "Level"
# sankeyNodePadding
sankeyNodePadding : 10
sankeyNodePadding : 30
# sankeyNodeSort
Order of the strata within each Sankey/alluvial column. auto: flow-based order that minimizes ribbon crossings (default). input: data order, no reordering. ascending/descending: by the stratum flow value. alphabetical: by the stratum name. factor: by each axis variable factor levels (ggalluvial parity); strata whose value has no defined level sort last, alphabetically
Type:
string
Default:
auto
Used in:
Sankey
sankeyNodeSort : "ascending"
sankeyNodeSort : "descending"
# sankeyNodeWidth
sankeyNodeWidth : 20
sankeyNodeWidth : 35
# sankeyNodesColor
sankeyNodesColor : "#9e0adb"
sankeyNodesColor : "#ff7d00"
# sankeyOutlineColor
sankeyOutlineColor : "#9e0adb"
sankeyOutlineColor : "#ff7d00"
# sankeySource
Name of a sample annotation to use as source in the sankey diagrams
Type:
string
Default:
Used in:
Sankey
# sankeyTarget
Name of a sample annotation to use as target in the sankey diagrams
Type:
string
Default:
Used in:
Sankey
# sankeyTextAlign
sankeyTextAlign : "left"
sankeyTextAlign : "center"
sankeyTextAlign : "right"
# sankeyTextAuto
Flag to adjust the text orientation and the visibility for the labels in the Sankey diagrams
Type:
boolean
Default:
true
Used in:
Sankey
sankeyTextAuto : true
sankeyTextAuto : false
# sankeyTextBaseline
Baseline (or reference line) for the sankey diagram labels
Type:
string
Default:
middle
Used in:
Sankey
sankeyTextBaseline : "top"
sankeyTextBaseline : "middle"
sankeyTextBaseline : "bottom"
# sankeyTextColor
sankeyTextColor : "#9e0adb"
sankeyTextColor : "#ff7d00"
# sankeyTextFontSize
Font size for the text in sankey diagram labels. Be aware that auto scaling font must be turned off for this property to take effect. A more convenient way to modify the size is to use the sankeyTextScaleFontFactor
Type:
integer
Default:
10
Used in:
Sankey
# sankeyTextFontStyle
sankeyTextFontStyle : ""
sankeyTextFontStyle : "bold"
sankeyTextFontStyle : "bold italic"
# sankeyTextInside
Flag to draw the text of the sankey labels inside the plot. It is only applicable when sankeyTextAuto is false
Type:
boolean
Default:
true
Used in:
Sankey
sankeyTextInside : true
sankeyTextInside : false
# sankeyTextMargin
Margin to pad or separate the characters in the sankey diagram labels
Type:
float
Default:
Used in:
Sankey
sankeyTextMargin : 5
sankeyTextMargin : 15
# sankeyTextRotate
sankeyTextRotate : 0
sankeyTextRotate : 90
# sankeyTextScaleFontFactor
Scaling factor used to increase or decrease the sankey diagram labels font size in the canvas
Type:
float
Default:
1
Used in:
Sankey
sankeyTextScaleFontFactor : 0.5
sankeyTextScaleFontFactor : 1
sankeyTextScaleFontFactor : 1.5
# sankeyTextShow
sankeyTextShow : true
sankeyTextShow : false
# sankeyTitleAlign
sankeyTitleAlign : "left"
sankeyTitleAlign : "center"
sankeyTitleAlign : "right"
# sankeyTitleBaseline
Baseline (or reference line) for the sankey diagram titles
Type:
string
Default:
middle
Used in:
Sankey
sankeyTitleBaseline : "top"
sankeyTitleBaseline : "middle"
sankeyTitleBaseline : "bottom"
# sankeyTitleColor
sankeyTitleColor : "#9e0adb"
sankeyTitleColor : "#ff7d00"
# sankeyTitleFontSize
Font size for the text in sankey diagram titles. Be aware that auto scaling font must be turned off for this property to take effect. A more convenient way to modify the size is to use the sankeyTitleScaleFontFactor
Type:
integer
Default:
10
Used in:
Sankey
# sankeyTitleFontStyle
sankeyTitleFontStyle : ""
sankeyTitleFontStyle : "bold"
sankeyTitleFontStyle : "bold italic"
# sankeyTitleMargin
Margin to pad or separate the characters in the sankey diagram titles
Type:
float
Default:
Used in:
Sankey
sankeyTitleMargin : 5
sankeyTitleMargin : 15
# sankeyTitlePosition
Position of the Sankey/alluvial axis (column) titles relative to the plot. bottom (default) draws them under the columns; top draws them above (ggplot scale_x position "top" parity)
Type:
string
Default:
bottom
Used in:
Sankey
sankeyTitlePosition : "bottom"
sankeyTitlePosition : "top"
# sankeyTitleRotate
sankeyTitleRotate : 0
sankeyTitleRotate : 90
# sankeyTitleScaleFontFactor
Scaling factor used to increase or decrease the sankey diagram titles font size in the canvas
Type:
float
Default:
1
Used in:
Sankey
sankeyTitleScaleFontFactor : 0.5
sankeyTitleScaleFontFactor : 1
sankeyTitleScaleFontFactor : 1.5
# sankeyTitleShow
sankeyTitleShow : true
sankeyTitleShow : false
# sankeyType
Height model for the Sankey/alluvial strata. normal: one shared scale across the whole diagram (columns with fewer classes are shorter). proportional: each stratum column is scaled independently to fill the full plot height, node heights stay proportional to their value, and the flow ribbons proportionally fill the node boxes at both ends. equal: every stratum (node) in a column gets the same height so the column is evenly partitioned, with the ribbons proportionally filling each equal node box at both ends. aligned: keeps the normal node heights but spreads the strata of each column evenly over the full plot height (overrides sankeyNodePadding)
Type:
string
Default:
normal
Used in:
Sankey
sankeyType : "normal"
sankeyType : "equal"
