filter.label: Filter the label of a SIMACAT object

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

Filter the label of a SIMACAT object

Description

This functions filters the label in a SIAMCAT object

Usage

filter.label(siamcat, ids, verbose = 1)

Arguments

siamcat	an object of class siamcat-class
ids	vector, can contain either names or indices of samples to be retained
verbose	integer, control output: 0 for no output at all, 1 for only information about progress and success, 2 for normal level of information and 3 for full debug information, defaults to 1

Details

This function filters the label contained in a SIAMCAT object, based on the provided ids. The IDs can be either sample names or indices to be retained.

Predominantly for internal use...

Please note: It makes sense to run validate.data after filtering the label.

Value

siamcat an object of class siamcat-class

Examples

data(siamcat_example)

# simple working example
siamcat_filtered <- filter.label(siamcat_example, ids=c(1:20))

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