View source: R/write.narrative.R

write.narrative | R Documentation |

`write.narrative`

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

```
write.narrative(
agents = 0,
artifacts = 0,
weighted = FALSE,
bipartite = FALSE,
symmetric = FALSE,
signed = FALSE,
mtc = "none",
alpha = NULL,
s = NULL,
ut = NULL,
lt = NULL,
trials = 0,
escore = NULL,
normalize = NULL,
filter = NULL,
umst = NULL,
model = "",
reduced_edges = NULL,
reduced_nodes = NULL
)
```

`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) |

`trials` |
integer: number of trials used to estimate FDSM or oSDSM p-values |

`escore` |
string: Method for scoring edges' importance |

`normalize` |
string: Method for normalizing edge scores |

`filter` |
string: Type of filter to apply |

`umst` |
boolean: TRUE if the backbone should include the union of minimum spanning trees, to ensure connectivity |

`model` |
string: name of backbone model |

`reduced_edges` |
numeric: percent reduction in number of edges |

`reduced_nodes` |
numeric: percent reduction in number of connected nodes |

NULL; only displays text in the console

Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.