molecule_filter {pmartR} | R Documentation |
Molecule Filter Object
Description
This function returns a moleculeFilt object for use with
applyFilt
Usage
molecule_filter(omicsData, use_groups = FALSE, use_batch = FALSE)
Arguments
omicsData |
object of the class 'pepData', 'proData', 'metabData',
'lipidData', 'nmrData', or 'seqData', created by |
use_groups |
logical indicator for whether to utilize group information
from |
use_batch |
logical indicator for whether to utilize batch information
from |
Details
Attribute of molecule_filt object is "total_poss_obs", the number of total possible observations for each feature (same as the number of samples)
Value
An S3 object of class 'moleculeFilt' (also a data.frame) that contains the molecule identifier and the number of samples for which the molecule was observed (i.e. not NA)
Author(s)
Kelly Stratton
Examples
library(pmartRdata)
to_filter <- molecule_filter(omicsData = pep_object)
summary(to_filter, min_num = 2)