calour docs
2018.10.1
Site
General Calour concepts
Microbiome tutorials
Metabolome tutorials
Using Calour functions via the module and the Experiment class
Main classes and utility functions
Functions operating on
Experiment
object
Creating database interfaces for Calour
Page
calour.experiment.Experiment.filter_samples
calour.experiment.Experiment.filter_samples
¶
Experiment.
filter_samples
(
field
,
values
,
negate=False
,
inplace=False
)
[source]
¶
Shortcut for filtering samples.
Parameters:
field
(
str
) – the column name of the sample metadata tables
values
– keep the samples with the values in the given field
negate
(
bool
,
optional
) – discard instead of keep the samples if set to
True
inplace
(
bool
,
optional
) – return the filtering on the original
Experiment
object or a copied one.
Returns:
the filtered object
Return type:
Experiment