pmartR (version 2.4.6)

summary.moleculeFilt: Molecule Filter Summary

Description

Provide summary of a moleculeFilt S3 object

Usage

# S3 method for moleculeFilt
summary(object, min_num = NULL, ...)

Value

a summary table giving the number of biomolecules by number of observed values across all samples. If min_num is specified, the numbers of biomolecules to be filtered and to be retained based on the specified threshold are reported. If, upon creation of moleculeFilt object,

use_groups = TRUE or use_batches = TRUE were specified, the numbers reported by the summary are based on groups and/or batches.

Arguments

object

S3 object of class 'moleculeFilt' created by molecule_filter

min_num

integer value specifying the minimum number of times each feature must be observed across all samples. Default value is NULL.

...

further arguments passed to or from other methods

Author

Lisa Bramer, Kelly Stratton

See Also

molecule_filter

Examples

if (FALSE) { # requireNamespace("pmartRdata", quietly = TRUE)
library(pmartRdata)
myfilter <- molecule_filter(omicsData = pep_object)
summary(myfilter)
summary(myfilter, min_num = 2)
}