summary.customFilt: Custom Filter Summary

View source: R/filter_summary.R

summary.customFiltR Documentation

Custom Filter Summary

Description

Provide summary of a customFilt S3 object

Usage

## S3 method for class 'customFilt'
summary(object, ...)

Arguments

object

S3 object of class 'customFilt' created by custom_filter.

...

further arguments passed to or from other methods

Value

a summary of the items in e_data, f_data, and e_meta that will be removed as a result of applying the custom filter.

Author(s)

Lisa Bramer

See Also

custom_filter

Examples


library(pmartRdata)
to_filter <- custom_filter(omicsData = metab_object, e_data_remove = "fumaric acid",
                           f_data_remove = "Sample_1_Phenotype2_B")
summary(to_filter)

to_filter2 <- custom_filter(omicsData = metab_object, 
                            f_data_keep = metab_object$f_data$SampleID[1:10])
summary(to_filter2)


pmartR/pmartR documentation built on March 4, 2024, 8:32 a.m.