rsd_filter {structToolbox} | R Documentation

## RSD filter

### Description

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

### Usage

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

### Arguments

`rsd_threshold` | (numeric) The RSD threshold above 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:

- `pmp`

### Value

A `rsd_filter` object with the following `output` slots:

`filtered` | (DatasetExperiment) A DatasetExperiment object containing the filtered data.
`flags` | (data.frame) RSD and a flag indicating whether the feature was rejected by the filter or not.
`rsd_qc` | (data.frame) The calculated RSD of the QC class.

### References

Jankevics A, Lloyd GR, Weber RJM (2021). pmp: Peak Matrix Processing and signal batch correction for metabolomics datasets. R package version 1.5.0.

### Examples

    M = rsd_filter(factor_name='Class')

[Package structToolbox version 1.6.1 Index]