fg_rm_summary {flowGraph} | R Documentation

## Removes a feature summary.

### Description

Removes a feature summary from a given flowGraph object; while `fg` is required, the user can choose to input parameters `summary_meta`, `index`, or all of `type`, `feat`, `test_name`, `class`, `label1`, and `label2`. See `fg_get_summary_desc` for details.

### Usage

    fg_rm_summary(fg, type = "node", index = NULL, summary_meta = NULL)

### Arguments

`fg` | flowGraph object.
`type` | A string indicating feature type the summary was created for; 'node' or 'edge'.
`index` | The user must provide `type` and additionally, one of `summary_meta` or `index`. `index` is an integer indicating the row in `fg_get_summary_desc(<flowGraph>)` of the corresponding type and summary the user would like to retrieve.
`summary_meta` | The user must provide `type` and additionally, one of `summary_meta` or `index`. `summary_meta` is a list containing `feat` (feature name), `test_name` (summary statistic name), `class` (class), `label1`, and `label2` (class labels compared). See `fg_get_summary_desc` for details.

### Value

flowGraph object.

### See Also

`flowGraph-class` `fg_get_summary` `fg_add_summary` `fg_get_summary_desc` `fg_rm_feature`

### Examples

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

     fg <- fg_summary(fg, no_cores=no_cores, class="class", label1="control",
                      overwrite=FALSE, test_name="wilcox_byLayer", diminish=FALSE,
                      node_features=NULL, edge_features=NULL)
     fg_get_summary_desc(fg)

     fg <- fg_rm_summary(fg, summary_meta=c(
         feature="count",test_name="wilcox_byLayer",
         class="class", label1="control", label2="exp"))
     fg_get_summary_desc(fg)

[Package flowGraph version 1.2.0 Index]