grand (version 0.9.1)

grand_manual: Manually add Guidelines for Reporting About Network Data (GRAND) information to an igraph object

Description

The grand_manual function allows a user to manually and non-interactively add GRAND information to an igraph object. Normally this information should be added interactively using grand(mode = "interview").

Usage

grand_manual(
  G,
  name = NA,
  doi = NA,
  url = NA,
  vertex1 = NA,
  vertex2 = NA,
  positive = NA,
  negative = NA,
  weight = NA,
  level = NA,
  mode = NA,
  year = NA
)

Value

An igraph object

Arguments

G

An igraph object, with weights/signs (if present) stored in E(G)$weight

name

string: Name of the network (e.g., Zachary Karate Club)

doi

string: DOI associated with the data (e.g., 10.1086/jar.33.4.3629752)

url

string: Link to data (e.g., https://networks.skewed.de/net/karate)

vertex1

string: Entity represented by nodes in a unipartite network, or by FALSE nodes in a bipartite network (e.g., people)

vertex2

string: Entity represented by TRUE nodes in a bipartite network

positive

string: Relationship represented by (positive) edges (e.g., friendship)

negative

string: Relationship represented by negative edges, if present

weight

string: What the edge weights represent (e.g., frequency, intensity, multiplexity)

level

string: Scale on which edge weights are measured (e.g., continuous, count, ordinal, categorical)

mode

string: Mode of data collection (e.g., survey, interview, sensor, observation, archival, simulation)

year

numeric: Year in which data was collected (e.g., 1977)

Examples

G <- igraph::make_graph("Zachary")  #An example network

G <- grand_manual(G,  #Manually enter information
     name = "Zachary Karate Club",
     doi = "10.1086/jar.33.4.3629752",
     url = "https://networks.skewed.de/net/karate",
     vertex1 = "People",
     positive = "Friendship",
     mode = "Observation",
     year = "1977")

grand(G, mode = "statement")  #Display summary statement