skbio.metadata.CategoricalMetadataColumn

class skbio.metadata.CategoricalMetadataColumn(series, missing_scheme='blank')

A single metadata column containing categorical data.

See the Metadata class docstring for details about Metadata and MetadataColumn objects, including a description of column types and supported data formats.

Attributes

type

Attributes (inherited)

id_count	Number of metadata IDs.
id_header	Name identifying the IDs associated with the metadata.
ids	IDs associated with the metadata.
missing_scheme	Return the vocabulary used to encode missing values.
name	Metadata column name.

Methods (inherited)

drop_missing_values()	Filter out missing values from the metadata column.
filter_ids(ids_to_keep)	Filter metadata column by IDs.
get_ids([where_values_missing])	Retrieve IDs matching search criteria.
get_missing()	Return a series containing only missing values (with an index).
get_value(id)	Retrieve metadata column value associated with an ID.
has_missing_values()	Determine if the metadata column has one or more missing values.
read([format])	Create a new CategoricalMetadataColumn instance from a file.
save(filepath[, ext])	Save a TSV metadata file.
to_dataframe([encode_missing])	Create a pandas dataframe from the metadata column.
to_series([encode_missing])	Create a pandas series from the metadata column.
write(file[, format])	Write an instance of CategoricalMetadataColumn to a file.

Special methods (inherited)

__eq__(other)	Determine if this metadata column is equal to another.
__ge__(value, /)	Return self>=value.
__getstate__(/)	Helper for pickle.
__gt__(value, /)	Return self>value.
__le__(value, /)	Return self<=value.
__lt__(value, /)	Return self<value.
__ne__(other)	Determine if this metadata column is not equal to another.
__str__(/)	Return str(self).

Details

type = 'categorical'