fg_get_summary_tables: Retrieves a table containing all node or edge summary...

View source: R/01_flowgraph_accessors.R

fg_get_summary_tablesR Documentation

Retrieves a table containing all node or edge summary statistics.

Description

Retrieves a table containing all node or edge summary statistics given a flowGraph object.

Usage

fg_get_summary_tables(fg, type = "node")

Arguments

fg

flowGraph object.

type

A string indicating feature type the summaries the user wants to retrieve were created for, 'node' or 'edge'.

Value

A list; this output is the same as that of function fg_get_graph with additional columns. These columns contain summary statistics from the summary slot of the flowGraph object. These columns are named: <feature type: node/edge>.<feature>.<summary name>.<class>.<class labels>.

See Also

flowGraph-class fg_get_feature_means fg_get_summary_desc fg_add_summary fg_rm_summary fg_get_summary fg_get_feature

Examples


 no_cores <- 1
 data(fg_data_pos30)
 fg <- flowGraph(fg_data_pos30$count, class=fg_data_pos30$meta$class,
                 no_cores=no_cores)

 fg <- fg_summary(fg, no_cores=no_cores, class="class", label1="control",
                  overwrite=FALSE, test_name="t", diminish=FALSE)
 show(fg)

 feat_summ_table_node <- fg_get_summary_tables(fg, type="node")
 head(feat_summ_table_node)


aya49/flowGraph documentation built on Feb. 4, 2024, 6:40 p.m.