d3Network (version 0.3.2)

d3ForceNetwork: Create a D3 JavaScript force directed network graph.

Description

Create a D3 JavaScript force directed network graph.

Usage

d3ForceNetwork(Links, Nodes, Source, Target,
    Value = NULL, NodeID, Group, height = 600, width = 900,
    fontsize = 7, linkDistance = 50, charge = -120,
    linkColour = "#666", opacity = 0.6, zoom = FALSE,
    standAlone = TRUE, file = NULL, iframe = FALSE,
    d3Script = "http://d3js.org/d3.v3.min.js")

Arguments

Links

a data frame object with the links between the nodes. It should have include the Source and Target for each link. An optional Value variable can be included to specify how close the nodes are to one another.

Nodes

a data frame containing the node id and properties of the nodes. If no ID is specified then the nodes must be in the same order as the Source variable column in the Links data frame. Currently only a grouping variable is allowed.

Source

character string naming the network source variable in the Links data frame.

Target

character string naming the network target variable in the Links data frame.

Value

character string naming the variable in the Links data frame for how far away the nodes are from one another.

NodeID

character string specifying the node IDs in the Nodes data frame.

Group

character string specifying the group of each node in the Nodes data frame.

height

numeric height for the network graph's frame area in pixels.

width

numeric width for the network graph's frame area in pixels.

fontsize

numeric font size in pixels for the node text labels.

linkDistance

numeric distance between the links in pixels (actually arbitrary relative to the diagram's size).

charge

numeric value indicating either the strength of the node repulsion (negative value) or attraction (positive value).

linkColour

character string specifying the colour you want the link lines to be. Multiple formats supported (e.g. hexadecimal).

opacity

numeric value of the proportion opaque you would like the graph elements to be.

zoom

logical, whether or not to enable the ability to use the mouse scroll-wheel to zoom in and out of the graph.

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

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.

source

D3.js was created by Michael Bostock. See http://d3js.org/ and, more specifically for force directed networks https://github.com/mbostock/d3/wiki/Force-Layout

Examples

#### Tabular data example.
# Load data
data(MisLinks)
data(MisNodes)

# Create graph
d3ForceNetwork(Links = MisLinks, Nodes = MisNodes, Source = "source",
               Target = "target", Value = "value", NodeID = "name",
               Group = "group", opacity = 0.4)

# dontrun
#### JSON Data Example
# Load data JSON formated data into two R data frames
# library(RCurl)
# MisJson <- getURL("http://bit.ly/1cc3anB")
# MisLinks <- JSONtoDF(jsonStr = MisJson, array = "links")
# MisNodes <- JSONtoDF(jsonStr = MisJson, array = "nodes")

# Create graph
# d3ForceNetwork(Links = MisLinks, Nodes = MisNodes, Source = "source",
#                Target = "target", Value = "value", NodeID = "name",
#                Group = "group", opacity = 0.4)