fg_get_summary_desc: Retrieves a feature summary description table.

View source: R/01_flowgraph_accessors.R

fg_get_summary_descR Documentation

Retrieves a feature summary description table.

Description

Retrieves a feature summary description table for a given flowGraph object.

Usage

fg_get_summary_desc(fg)

Arguments

fg

flowGraph object.

Value

A data frame where each row contains information on a feature summary from fg:

  • type: feature type (i.e. 'node' or 'edge').

  • feat: feature name.

  • test_name: summary name.

  • class: class or the column name of fg_get_meta(fg) whose values represent the class label of each sample on which the summary was created for.

  • label1: A string from the class column of the meta slot indicating the label of samples compared.

  • label2: A string from the class column of the meta slot indicating the label of samples compared.

See Also

flowGraph-class fg_get_summary fg_add_summary fg_rm_summary fg_get_feature_desc

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_get_summary_desc(fg)


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