pertdb.EnvironmentalPerturbation .md

class pertdb.EnvironmentalPerturbation(*args, **kwargs)

Bases: BioRecord, TracksRun, TracksUpdates

Models environmental perturbations such as heat, acid, or smoke perturbations.

Parameters:

  • name – Name of the environmental perturbation.

  • ontology_id – Ontology ID of the environmental perturbation (EFO).

  • value – A value such as a temperature.

  • unit – A unit such as ‘degrees celsius’.

  • duration – Time duration of how long the perturbation was applied.

Example:

import pertdb

acid_perturbation = EnvironmentalPerturbation(
    name='Acid perturbation',
    ontology_id='EFO:0004416',
    value=1.5,
    unit='pH',
).save()
name: str

Name of the environmental perturbation.

ontology_id

Ontology ID (EFO) of the environmental perturbation.

value: float | None

The value of the environmental perturbation such as a temperature.

unit: str | None

Unit of the value such as ‘degrees celsius’

duration: timedelta | None

Duration of the environmental perturbation.

targets: PerturbationTarget

Targets of the environmental perturbation.

artifacts: Artifact

Artifacts linked to the perturbation.