grand {grand}R Documentation

Applies Guidelines for Reporting About Network Data

Description

The grand function interactively adds information about a network and generates a narrative summary of the network following the Guidelines for Reporting About Network Data.

Usage

grand(G, mode, help = FALSE, verbose = FALSE)

Arguments

G

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

mode

string: "interview" to interactively add information, or "statement" to generate a summary statement

help

boolean: Should interview prompts be accompanied by explanations and examples?

verbose

boolean: Should an extended summary be generated?

Value

An igraph object if mode == "interview", or a string if mode == "statement"

Examples

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

#G <- grand(G, mode = "interview")  #Interactively enter information...

G <- grand_manual(G,  #...or 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


[Package grand version 0.9.1 Index]