bionty.CellMarker#
- class bionty.CellMarker(species='human', source=None, version=None, **kwargs)#
Bases:
Bionty
Cell markers.
1. Cell Marker Ontology Edits of terms are coordinated and reviewed on: http://bio-bigdata.hrbmu.edu.cn/CellMarker/
- Parameters:
species –
name
ofSpecies
entity.source – The key of the source in the local.yml versions file. Get all available databases with
bionty.display_available_versions
.version – The version of the ontology. Typically a date or an actual version. Get available versions with
bionty.display_available_versions
.
Attributes
- source :class:`~<class 'property'>`#
Name of the source.
- species :class:`~<class 'property'>`#
The
name
ofSpecies
Bionty.
- version :class:`~<class 'property'>`#
The
name
ofversion
entity Bionty.
Methods
- curate(df, column=None, reference_id='name')#
Curate index of passed DataFrame to conform with default identifier.
In addition to the .curate() in base class, this also performs alias mapping.
- Parameters:
df – DataFrame with a column of identifiers
- column: If
column
isNone
, checks the existing index for compliance with the default identifier.
- If
column
denotes an entity identifier, tries to map that identifier to the default identifier.
- If
reference_id: The type of identifier for mapping.
- Return type:
DataFrame
- Returns:
The input DataFrame with the curated index and a boolean
__curated__
column that indicates compliance with the default identifier.
- df()#
DataFrame.
See ingestion: https://lamin.ai/docs/bionty-assets/ingest/cell-marker-2.0
- Return type:
DataFrame