set_filter: Sets/updates the filters attribute with a filter class...

View source: R/helper_fn.R

set_filterR Documentation

Sets/updates the filters attribute with a filter class object.

Description

This function will create a filter class object. The output will always have the same elements but not all of them will be used for every filter type. This object will be appended to the list in the filters attribute for an omicsData object.

Usage

set_filter(type, threshold, filtered, method)

Arguments

type

The type of filter, see filter_objects.R

threshold

The threshold for filtering applied, if applicable.

filtered

The samples/biomolecules that are filtered.

method

A list of metadata about what method was used in applying the filter.

Value

A list containing all the elements in the filters attribute: (list all attributes)


pmartR/pmartRqc documentation built on April 25, 2024, 6:18 a.m.