wpa (version 1.4.3)

network_g2g: Create a network plot with the group-to-group query

Description

Pass a data frame containing a group-to-group query and return a network plot. Automatically handles "Collaborators_within_group" and "Other_collaborators" within query data.

Usage

network_g2g(
  data,
  time_investor = NULL,
  collaborator = NULL,
  metric = "Collaboration_hours",
  algorithm = "fr",
  node_colour = "lightblue",
  exc_threshold = 0.1,
  org_count = NULL,
  subtitle = "Collaboration Across Organizations",
  return = "plot"
)
g2g_network(
  data,
  time_investor = NULL,
  collaborator = NULL,
  metric = "Collaboration_hours",
  algorithm = "fr",
  node_colour = "lightblue",
  exc_threshold = 0.1,
  org_count = NULL,
  subtitle = "Collaboration Across Organizations",
  return = "plot"
)

Arguments

data

Data frame containing a G2G query.

time_investor

String containing the variable name for the Time Investor column.

collaborator

String containing the variable name for the Collaborator column.

metric

String containing the variable name for metric. Defaults to Collaboration_hours.

algorithm

String to specify the node placement algorithm to be used. Defaults to "fr" for the force-directed algorithm of Fruchterman and Reingold. See https://rdrr.io/cran/ggraph/man/layout_tbl_graph_igraph.html for a full list of options.

node_colour

String to specify the colour to be used for displaying nodes. Defaults to "lightblue". If "vary" is supplied, a different colour is shown for each node at random.

exc_threshold

Exclusion threshold to apply.

org_count

Optional data frame to provide the size of each organization in the collaborator attribute. The data frame should contain only two columns:

• Name of the collaborator attribute excluding any prefixes, e.g. "Organization". Must be of character or factor type.

• "n". Must be of numeric type. Defaults to NULL, where node sizes will be fixed.

subtitle

String to override default plot subtitle.

return

String specifying what to return. This must be one of the following strings:

• "plot"

• "table"

• "network"

• "data"

See Value for more information.

Value

A different output is returned depending on the value passed to the return argument:

• "plot": 'ggplot' object. A group-to-group network plot.

• "table": data frame. An interactive matrix of the network.

• "network: 'igraph' object used for creating the network plot.

• "data": data frame. A long table of the underlying data.

See Also

Other Network: external_network_plot(), g2g_data, internal_network_plot(), network_describe(), network_leiden(), network_louvain(), network_p2p(), p2p_data_sim()

Examples

# NOT RUN {
# Return a network plot
g2g_data %>% network_g2g()

# Return a network plot - Meeting hours and 5% threshold
g2g_data %>%
  network_g2g(time_investor = "TimeInvestors_Organization",
              collaborator = "Collaborators_Organization",
              metric = "Meeting_hours",
              exc_threshold = 0.05)

# Return a network plot with circle layout
# Vary node colours and add org sizes
org_tb <- hrvar_count(
  sq_data,
  hrvar = "Organization",
  return = "table"
)

g2g_data %>%
  network_g2g(algorithm = "circle",
              node_colour = "vary",
              org_count = org_tb)

# Return an interaction matrix
# Minimum arguments specified
g2g_data %>%
  network_g2g(return = "table")


# }