Usage
d3ClusterDendro(List, height = 2200, width = 900, heightCollapse = 0, widthCollapse = 0.5, fontsize = 10, linkColour = "#ccc", nodeColour = "#3182bd", textColour = "#3182bd", opacity = 0.8, diameter = 980, zoom = FALSE, parentElement = "body", standAlone = TRUE, file = NULL, iframe = FALSE, d3Script = "http://d3js.org/d3.v3.min.js")
Arguments
List
a hierarchical list object with a root node and children.
height
numeric height for the network graph's frame area in pixels.
width
numeric width for the network graph's frame area in pixels.
heightCollapse
numeric proportion of the overall graph height
to make the cluster dendrogram shorter by.
widthCollapse
numeric proportion of the overall graph width
to
make the cluster dendrogram narrower by.
fontsize
numeric font size in pixels for the node text labels.
linkColour
character string specifying the colour you want the link
lines to be. Multiple formats supported (e.g. hexadecimal).
nodeColour
character string specifying the colour you want the node
circles to be. Multiple formats supported (e.g. hexadecimal).
textColour
character string specifying the colour you want the text
to be before they are clicked. Multiple formats supported (e.g. hexadecimal).
opacity
numeric value of the proportion opaque you would like the
graph elements to be.
diameter
numeric diameter for the network in pixels.
zoom
logical, whether or not to enable the ability to use the mouse
scroll-wheel to zoom in and out of the graph.
parentElement
character string specifying the parent element for the
resulting svg network graph. This effectively allows the user to specify
where on the html page the graph will be placed. By default the parent
element is body
.
standAlone
logical, whether or not to return a complete HTML document
(with head and foot) or just the script.
file
a character string of the file name to save the resulting graph.
If a file name is given a standalone webpage is created, i.e. with a header
and footer. If file = NULL
then result is returned to the console.
iframe
logical. If iframe = TRUE
then the graph is saved to an
external file in the working directory and an HTML iframe
linking to
the file is printed to the console. This is useful if you are using Slidify
and many other HTML slideshow framworks and want to include the graph in the
resulting page. If you set the knitr code chunk results='asis'
then
the graph will be rendered in the output. Usually, you can use
iframe = FALSE
if you are creating simple knitr Markdown or HTML
pages. Note: you do not need to specify the file name if
iframe = TRUE
, however if you do, do not include the file path.
d3Script
a character string that allows you to specify the location of
the d3.js script you would like to use. The default is
http://d3js.org/d3.v3.min.js.