skbio.metadata.SampleMetadata.filter_ids

SampleMetadata.filter_ids(ids_to_keep)

Filter metadata by IDs.

Parameters:

ids_to_keepiterable of str

IDs that should be retained in the filtered Metadata object. If any IDs in ids_to_keep are not contained in this Metadata object, a ValueError will be raised. The filtered Metadata object will retain the same relative ordering of IDs in this Metadata object. Thus, the ordering of IDs in ids_to_keep does not determine the ordering of IDs in the filtered Metadata object.

Returns:

Metadata

The metadata filtered by IDs.

See also

get_ids

filter_columns