filt_feat-methods: Retrieve the information stored in the 'filt_feat' slot...

In zellerlab/siamcat: Statistical Inference of Associations between Microbial Communities And host phenoTypes

Retrieve the information stored in the filt_feat slot within a SIAMCAT object

Description

Function to retrieve the information stored in the filt_feat slot within a SIAMCAT object

Usage

filt_feat(siamcat, verbose=1)

## S4 method for signature 'siamcat'
filt_feat(siamcat, verbose = 1)

Arguments

siamcat	(Required). An instance of siamcat-class that contains filtered features
verbose	integer, if the slot is empty, should a message be printed? values can be either 0 (no output) or 1 (print message)

Details

The function will return a list containing the information stored in the filt_feat slot of a SIAMCAT object. This list contains:

• filt.feat - filtered features as matrix, see get.filt_feat.matrix

• filt.param - parameters used for feature filtering, see get.filt_feat.matrix

Value

The list stored in the filt_feat slot of the SIAMCAT object or NULL

Examples

data(siamcat_example)
temp <- filt_feat(siamcat_example)
names(temp)

zellerlab/siamcat documentation built on Feb. 1, 2024, 2:21 a.m.