DiagrammeR (version 0.9.2)

node_type: Create, read, update, delete, or report status of a node type definition

Description

From a graph object of class dgr_graph, query a node in the graph (using the node ID) and perform operations on the type definition for that node.

Usage

node_type(graph, node, action = "read", value = NULL)

Arguments

graph

a graph object of class dgr_graph.

node

a node ID corresponding to the node to be selected.

action

the operation to perform on the node's type attribute. To remove the type definition from a node, use either delete, remove, or drop. To add a type definition to a node with no type set, use add or create. To update a node's type definition, use update. To return the value of a node type, use read. To determine whether there is a type set for the selected node, use check.

value

a string denoting the node type, to be supplied when either adding or updating a node type definition.

Value

a graph object of class dgr_graph.

Examples

# NOT RUN {
# Create a node data frame (ndf)
ndf <-
  create_node_df(
    n = 5,
    type = c("a", "b", "c", "a", "c"))

# Create an edge data frame (edf)
edf <-
  create_edge_df(
    from = c(1, 3, 5, 2, 4),
    to = c(2, 2, 4, 4, 3))

# Create a graph
graph <-
  create_graph(
    nodes_df = ndf,
    edges_df = edf)

# Read the node `type` for node `1`
graph %>%
  node_type(node = 1)
#> [1] "a"

# Remove the `type` value entirely from
# node `1`
graph <-
  graph %>%
  node_type(
    node = 1,
    action = "delete")

# Check that node `1` no longer has a
# `type` assignment
graph %>%
  node_type(
    node = 1,
    action = "check")
#> [1] FALSE

# Add the `type` value "b" to node `1`
graph <-
  graph %>%
  node_type(1, "add", "b")

# Read the node `type` for node `1`
graph %>%
  node_type(node = 1)
#> [1] "b"

# Perform an in-place update of the `type`
# value for node `1` ("b" to "a")
graph <-
  graph %>%
  node_type(
    node = 1,
    action = "update",
    value = "a")

# Read the node `type` for node `1` to ensure
# that the change was made
graph %>%
  node_type(node = 1)
#> [1] "a"
# }