scvi.data.fields.CategoricalObsField#

class scvi.data.fields.CategoricalObsField(registry_key, obs_key)[source]#

An AnnDataField for categorical .obs attributes in the AnnData data structure.

Parameters:
  • registry_key (str) – Key to register field under in data registry.

  • obs_key (Optional[str]) – Key to access the field in the AnnData obs mapping. If None, defaults to registry_key.

Attributes table#

CATEGORICAL_MAPPING_KEY

ORIGINAL_ATTR_KEY

attr_key

The key of the data field within the relevant AnnData attribute.

attr_name

The name of the AnnData attribute where the data is stored.

is_empty

Returns True if the field is empty as a function of its kwargs.

mod_key

The modality key of the data field within the MuData (if applicable).

registry_key

The key that is referenced by models via a data loader.

Methods table#

get_data_registry()

Returns a nested dictionary which describes the mapping to the data field.

get_field_data(adata)

Returns the requested data as determined by the field for a given AnnData/MuData object.

get_summary_stats(state_registry)

Get summary stats.

register_field(adata)

Register field.

transfer_field(state_registry, adata_target)

Transfer field from registry to target AnnData.

validate_field(adata)

Validate field.

view_state_registry(state_registry)

View state registry.

Attributes#

CATEGORICAL_MAPPING_KEY

CategoricalObsField.CATEGORICAL_MAPPING_KEY = 'categorical_mapping'#

ORIGINAL_ATTR_KEY

CategoricalObsField.ORIGINAL_ATTR_KEY = 'original_key'#

attr_key

CategoricalObsField.attr_key[source]#
Return type:

str

attr_name

CategoricalObsField.attr_name[source]#
Return type:

str

is_empty

CategoricalObsField.is_empty[source]#
Return type:

bool

mod_key

CategoricalObsField.mod_key[source]#

The modality key of the data field within the MuData (if applicable).

Return type:

Optional[str]

registry_key

CategoricalObsField.registry_key[source]#
Return type:

str

Methods#

get_data_registry

CategoricalObsField.get_data_registry()[source]#

Returns a nested dictionary which describes the mapping to the data field.

The dictionary is of the form {“mod_key”: mod_key, “attr_name”: attr_name, “attr_key”: attr_key}. This mapping is then combined with the mappings of other fields to make up the data registry.

Return type:

dict

get_field_data

CategoricalObsField.get_field_data(adata)[source]#

Returns the requested data as determined by the field for a given AnnData/MuData object.

Return type:

Union[ndarray, DataFrame]

get_summary_stats

CategoricalObsField.get_summary_stats(state_registry)[source]#

Get summary stats.

Return type:

dict

register_field

CategoricalObsField.register_field(adata)[source]#

Register field.

Return type:

dict

transfer_field

CategoricalObsField.transfer_field(state_registry, adata_target, extend_categories=False, **kwargs)[source]#

Transfer field from registry to target AnnData.

Return type:

dict

validate_field

CategoricalObsField.validate_field(adata)[source]#

Validate field.

Return type:

None

view_state_registry

CategoricalObsField.view_state_registry(state_registry)[source]#

View state registry.

Return type:

Optional[Table]