write.narrative: Generates suggested manuscript text

In backbone: Extracts the Backbone from Graphs

Generates suggested manuscript text

Description

write.narrative displays suggested text and references that can be used in a manuscript to describe the extracted backbone

Usage

write.narrative(
  agents,
  artifacts,
  weighted,
  bipartite,
  symmetric,
  signed,
  mtc,
  alpha,
  s,
  ut,
  lt,
  trials,
  model,
  reduced_edges,
  reduced_nodes
)

Arguments

agents	integer: number of agents in a bipartite graph, or nodes in a unipartite graph
artifacts	integer: number of artifacts in a bipartite graph
weighted	boolean: TRUE if input graph was weighted
bipartite	boolean: TRUE if input graph was bipartite
symmetric	boolean: TRUE if input graph was symmetric
signed	boolean: TRUE if a signed backbone was requested
mtc	string: type of multiple test correction
alpha	numeric: alpha significance threshold (used in statistical models)
s	numeric: sparsification parameter (used in sparsification models)
ut	numeric: upper threshold (used in global threshold)
lt	numeric: lower threshold (used in global threshold)
model	string: name of backbone null model
reduced_edges	numeric: percent reduction in number of edges
reduced_nodes	numeric: percent reduction in number of connected nodes
trials:	integer: number of trials used to estimate FDSM or oSDSM p-values

Value

NULL; only displays text in the console

backbone documentation built on Feb. 16, 2023, 6:13 p.m.