summaryNet: Print summary of graph results

Description Usage Arguments Value Examples

View source: R/summaryNet.R

Description

Returns a summary of the processed graph results on console. The initial graph configuration and core analysis is required for this function to work. The other components are optional due to the modular nature of the functions. Data must be stored as a data object.

Usage

1
2
3
4
5
6
summaryNet(
  netintconfigData = NULL,
  coreNetAnalysisData = NULL,
  subgroupsNetAnalysisData = NULL,
  display = FALSE
)

Arguments

netintconfigData

Data object where the graph configuration data is stored (from 'prepareGraphs')

coreNetAnalysisData

Data object where the core analysis data is stored (from 'coreNetAnalysis')

subgroupsNetAnalysisData

Data object where subgroup analysis data is stored (from 'subgroupsNetAnalysis')

display

Should the output be displayed in the R console? Results are saved as the project name in the initial config data as a text file on disk.

Value

Prints organized summary of all results of the graph with modular components on console or to .txt file on disk.

Examples

1
2
3
4
5
6
7
8
df <- sampleData1
prepNet <- tabulate_edges(df, iscsvfile = FALSE)
prepGraphs <- prepareGraphs(prepNet, project_title = "Sample Data 1",
directedNet = TRUE, selfInteract = FALSE, weightedGraph = TRUE)
coreNet <- coreNetAnalysis(prepGraphs)
subgroup <- subgroupsNetAnalysis(prepGraphs, raw_input = df)
summaryNet(netintconfigData = prepGraphs, coreNetAnalysisData = coreNet,
subgroupsNetAnalysisData = subgroup, display = TRUE)

discourseGT documentation built on March 26, 2020, 7:52 p.m.