lamindb.Modality#

class lamindb.Modality(name: str, ontology_id: str, abbr: Optional[str], description: Optional[str])#
class lamindb.Modality(*db_args)

Bases: Registry, HasParents, CanValidate

Measurement types of features.

Note

This will soon borrow readout-related records from the experimental factor ontology, see ExperimentalFactor.

Parameters:

  • name – str A name.

  • ontology_id – Optional[str] A public ontology ID.

  • abbr – Optional[str] An abbreviation.

  • description – Optional[str] A description.

Fields

id CharField

Universal id, valid across DB instances.

name CharField

Name of the modality (required).

ontology_id CharField

Ontology ID of the modality.

abbr CharField

A unique abbreviation for the modality (optional).

synonyms TextField

Bar-separated (|) synonyms that correspond to this modality.

description TextField

Description.

molecule TextField

Molecular experimental factor, parsed from EFO.

instrument TextField

Instrument used to measure, parsed from EFO.

measurement TextField

Phenotypic experimental factor, parsed from EFO.

created_at DateTimeField

Time of creation of record.

updated_at DateTimeField

Time of last update to record.

created_by ForeignKey

Creator of record, a User.

parents ManyToManyField

Parents.

Methods