initSankey: initSankey

Description Usage Arguments Value Examples

View source: R/functions.R

Description

Internally generates supporting JavaScript and CSS files.

Usage

1
2
3
4
initSankey(pathOpacity = 0.2, pathHover = 0.5,
  font = "lato, helvetica, sans-serif", fontsize = NULL,
  fontsizeProportion = TRUE, d3js = NULL, sankeyjsFile = NULL,
  d3jsMethod = "auto", sankeyjsMethod = "auto")

Arguments

pathOpacity

Opacity of connecting path between nodes in the figure.

pathHover

Opacity of connecting path between nodes upon mouseover.

font

Font used for the node names and additional mouseover text in figure.

fontsize

Pixel font size used for the visible node names. Use to adjust range of font sizes (with proportions) or to set a single font size when fontsizeProportion is disabled.

fontsizeProportion

Boolean to enable/disable text being proportional to node widths. When enabled, all node names will appear with parameter fontsize.

d3js

Path to download latest zip version of D3 library. e.g. https://github.com/mbostock/d3/releases/download/v3.5.16/d3.zip. See http://www.d3js.org for more details. If NULL, will use version 3.5.16 currently installed with Director.

sankeyjsFile

Path to download sankey javascript file. If NULL, will use version installed with Director (https://raw.githubusercontent.com/d3/d3-plugins/master/sankey/sankey.js)

d3jsMethod

Function method to use to download D3 library. ?download.file for more detail on parameter.

sankeyjsMethod

Function method to use to download sankey script. ?download.file for more detail on parameter.

Value

global JavaScript and CSS files.

Examples

1
initSankey() # Generates supporting JavaScript and CSS files.

kzouchka/Director documentation built on Oct. 10, 2020, 5:29 p.m.