rsd_filter: RSD filter

Description Usage Arguments Details Value References Examples

View source: R/rsd_filter.R

Description

An RSD filter calculates the relative standard deviation (the ratio of the mean to the standard deviation) for all features. Any feature with an RSD lower than a predefined threshold is excluded.

Usage

1
rsd_filter(rsd_threshold = 20, qc_label = "QC", factor_name, ...)

Arguments

rsd_threshold

(numeric) The RSD threshold below which features are removed. The default is 20.

qc_label

(character) The label used to identify QC samples. The default is "QC".

factor_name

(character) The name of a sample-meta column to use.

...

Additional slots and values passed to struct_class.

Details

This object makes use of functionality from the following packages:

Value

A rsd_filter object.

References

Jankevics A, Weber RJM (2020). pmp: Peak Matrix Processing and signal batch correction for metabolomics datasets. R package version 1.1.0.

Examples

1
M = rsd_filter(factor_name='class')

structToolbox documentation built on Nov. 8, 2020, 6:54 p.m.