sigmajs (version 0.1.5)

sg_drop_nodes: Drop

Description

Drop nodes or edges.

Usage

sg_drop_nodes(sg, data, ids, delay, cumsum = TRUE)
sg_drop_edges(sg, data, ids, delay, cumsum = TRUE, refresh = FALSE)

Arguments

sg

An object of class sigmajsas intatiated by sigmajs.

data

Data.frame (or list) of nodes or edges.

ids

Ids of elements to drop.

delay

Column name containing delay in milliseconds.

cumsum

Whether to compute the cumulative sum of the delay.

refresh

Whether to refresh the graph after node is dropped, required to take effect, if you are running force the algorithm is killed and restarted at every iteration.

Value

A modified version of the sg object.

Details

The delay helps for build dynamic visualisations where nodes and edges do not disappear all at the same time. How the delay works depends on the cumsum parameter. if TRUE the function computes the cumulative sum of the delay to effectively drop each row one after the other: delay is thus applied at each row (number of seconds to wait before the row is dropped *since the previous row*). If FALSE this is the number of milliseconds to wait before the node or edge is dropped to the visualisation; delay is used as passed to the function.

Examples

# NOT RUN {
nodes <- sg_make_nodes(75)

# nodes to drop
nodes2 <- nodes[sample(nrow(nodes), 50), ]
nodes2$delay <- runif(nrow(nodes2), 1000, 3000)

sigmajs() %>% 
  sg_nodes(nodes, id, size, color) %>% 
  sg_drop_nodes(nodes2, id, delay, cumsum = FALSE)

# }