summary.cvFilt: Coefficient of Variation (CV) Filter Summary

View source: R/filter_summary.R

summary.cvFiltR Documentation

Coefficient of Variation (CV) Filter Summary

Description

Provide summary of a cvFilt S3 object

Usage

## S3 method for class 'cvFilt'
summary(object, cv_threshold = NULL, ...)

Arguments

object

S3 object of class 'cvFilt' created by cv_filter.

cv_threshold

numeric value greater than 1 and less than the value given by filter_object$CV. CV values above cv_threshold are filtered out. Default value is NULL.

...

further arguments passed to or from other methods

Value

a summary of the CV values, number of NA values, and non-NA values. If a CV threshold is provided, the biomolecules that would be filtered based on this threshold are reported.

Author(s)

Lisa Bramer

See Also

cv_filter

Examples


library(pmartRdata)
mypep <- group_designation(omicsData = pep_object, main_effects = "Phenotype")
to_filter <- cv_filter(omicsData = mypep, use_groups = TRUE)
summary(to_filter, cv_threshold = 30)


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