Organism

lamindb provides access to the following public Organism ontologies through bionty:

  1. Ensembl Species

  2. NCBI Taxonomy

Here we show how to access and search Organism ontologies to standardize new data.

import bionty as bt
import pandas as pd

PublicOntology objects

Let us create a public ontology accessor with .public method, which chooses a default public ontology source from Source. It’s a PublicOntology object, which you can think about as a public registry:

organisms = bt.Organism.public(organism="vertebrates")
organisms
→ connected lamindb: testuser1/test-public-ontologies
PublicOntology
Entity: Organism
Organism: vertebrates
Source: ensembl, release-112
#terms: 324

As for registries, you can export the ontology as a DataFrame:

df = organisms.df()
df.head()
scientific_name division ontology_id assembly assembly_accession genebuild variation microarray pan_compara peptide_compara genome_alignments other_alignments core_db species_id
name
spiny chromis acanthochromis_polyacanthus EnsemblVertebrates NCBITaxon:80966 ASM210954v1 GCA_002109545.1 2018-05-Ensembl/2020-03 N N N Y Y Y acanthochromis_polyacanthus_core_112_1 1
eurasian sparrowhawk accipiter_nisus EnsemblVertebrates NCBITaxon:211598 Accipiter_nisus_ver1.0 GCA_004320145.1 2019-07-Ensembl/2019-09 N N N N N Y accipiter_nisus_core_112_1 1
giant panda ailuropoda_melanoleuca EnsemblVertebrates NCBITaxon:9646 ASM200744v2 GCA_002007445.2 2020-05-Ensembl/2020-06 N N N Y Y Y ailuropoda_melanoleuca_core_112_2 1
yellow-billed parrot amazona_collaria EnsemblVertebrates NCBITaxon:241587 ASM394721v1 GCA_003947215.1 2019-07-Ensembl/2019-09 N N N N N Y amazona_collaria_core_112_1 1
midas cichlid amphilophus_citrinellus EnsemblVertebrates NCBITaxon:61819 Midas_v5 GCA_000751415.1 2018-05-Ensembl/2018-07 N N N Y Y Y amphilophus_citrinellus_core_112_5 1

Unlike registries, you can also export it as a Pronto object via public.ontology.

Look up terms

As for registries, terms can be looked up with auto-complete:

lookup = organisms.lookup()

The . accessor provides normalized terms (lower case, only contains alphanumeric characters and underscores):

lookup.giant_panda
Organism(name='giant panda', scientific_name='ailuropoda_melanoleuca', division='EnsemblVertebrates', ontology_id='NCBITaxon:9646', assembly='ASM200744v2', assembly_accession='GCA_002007445.2', genebuild='2020-05-Ensembl/2020-06', variation='N', microarray='N', pan_compara='N', peptide_compara='Y', genome_alignments='Y', other_alignments='Y', core_db='ailuropoda_melanoleuca_core_112_2', species_id=1)

To look up the exact original strings, convert the lookup object to dict and use the [] accessor:

lookup_dict = lookup.dict()
lookup_dict["giant panda"]
Organism(name='giant panda', scientific_name='ailuropoda_melanoleuca', division='EnsemblVertebrates', ontology_id='NCBITaxon:9646', assembly='ASM200744v2', assembly_accession='GCA_002007445.2', genebuild='2020-05-Ensembl/2020-06', variation='N', microarray='N', pan_compara='N', peptide_compara='Y', genome_alignments='Y', other_alignments='Y', core_db='ailuropoda_melanoleuca_core_112_2', species_id=1)

By default, the name field is used to generate lookup keys. You can specify another field to look up:

lookup = organisms.lookup(organisms.scientific_name)
lookup.ailuropoda_melanoleuca
Organism(name='giant panda', scientific_name='ailuropoda_melanoleuca', division='EnsemblVertebrates', ontology_id='NCBITaxon:9646', assembly='ASM200744v2', assembly_accession='GCA_002007445.2', genebuild='2020-05-Ensembl/2020-06', variation='N', microarray='N', pan_compara='N', peptide_compara='Y', genome_alignments='Y', other_alignments='Y', core_db='ailuropoda_melanoleuca_core_112_2', species_id=1)

Search terms

Search behaves in the same way as it does for registries:

organisms.search("rabbit").head(3)
scientific_name division ontology_id assembly assembly_accession genebuild variation microarray pan_compara peptide_compara genome_alignments other_alignments core_db species_id __ratio__
name
rabbit oryctolagus_cuniculus EnsemblVertebrates NCBITaxon:9986 OryCun2.0 GCA_000003625.1 2009-11-Ensembl/2019-05 N Y N Y Y Y oryctolagus_cuniculus_core_112_2 1 100.0
blue-ringed sea krait laticauda_laticaudata EnsemblVertebrates NCBITaxon:8630 latLat_1.0 GCA_004320025.1 2019-11-Ensembl/2019-12 N N N Y Y Y laticauda_laticaudata_core_112_1 1 72.0
rat rattus_norvegicus EnsemblVertebrates NCBITaxon:10116 mRatBN7.2 GCA_015227675.2 2020-11-Ensembl/2022-03 Y Y N Y Y Y rattus_norvegicus_core_112_72 1 72.0

By default, search also covers synonyms:

organisms.search("sapiens").head(3)
scientific_name division ontology_id assembly assembly_accession genebuild variation microarray pan_compara peptide_compara genome_alignments other_alignments core_db species_id __ratio__
name
swainson's thrush catharus_ustulatus EnsemblVertebrates NCBITaxon:91951 bCatUst1.pri GCA_009819885.1 2020-01-Ensembl/2020-03 N N N N N Y catharus_ustulatus_core_112_1 1 69.230769
spiny chromis acanthochromis_polyacanthus EnsemblVertebrates NCBITaxon:80966 ASM210954v1 GCA_002109545.1 2018-05-Ensembl/2020-03 N N N Y Y Y acanthochromis_polyacanthus_core_112_1 1 65.454545
common snapping turtle chelydra_serpentina EnsemblVertebrates NCBITaxon:8475 Chelydra_serpentina-1.0 GCA_007922165.1 2019-11-Ensembl/2019-12 N N N N N Y chelydra_serpentina_core_112_1 1 64.285714

You can turn this off synonym by passing synonyms_field=None:

organisms.search("sapiens", synonyms_field=None).head(3)
scientific_name division ontology_id assembly assembly_accession genebuild variation microarray pan_compara peptide_compara genome_alignments other_alignments core_db species_id __ratio__
name
swainson's thrush catharus_ustulatus EnsemblVertebrates NCBITaxon:91951 bCatUst1.pri GCA_009819885.1 2020-01-Ensembl/2020-03 N N N N N Y catharus_ustulatus_core_112_1 1 69.230769
spiny chromis acanthochromis_polyacanthus EnsemblVertebrates NCBITaxon:80966 ASM210954v1 GCA_002109545.1 2018-05-Ensembl/2020-03 N N N Y Y Y acanthochromis_polyacanthus_core_112_1 1 65.454545
common snapping turtle chelydra_serpentina EnsemblVertebrates NCBITaxon:8475 Chelydra_serpentina-1.0 GCA_007922165.1 2019-11-Ensembl/2019-12 N N N N N Y chelydra_serpentina_core_112_1 1 64.285714

Search another field (default is .name):

organisms.search(
    "oryctolagus_cuniculus",
    field=organisms.scientific_name,
).head()
name division ontology_id assembly assembly_accession genebuild variation microarray pan_compara peptide_compara genome_alignments other_alignments core_db species_id __ratio__
scientific_name
oryctolagus_cuniculus rabbit EnsemblVertebrates NCBITaxon:9986 OryCun2.0 GCA_000003625.1 2009-11-Ensembl/2019-05 N Y N Y Y Y oryctolagus_cuniculus_core_112_2 1 100.000000
mus_musculus mouse EnsemblVertebrates NCBITaxon:10090 GRCm39 GCA_000001635.9 2020-08-Ensembl/2023-12 Y Y Y Y Y Y mus_musculus_core_112_39 1 67.500000
mola_mola ocean sunfish EnsemblVertebrates NCBITaxon:94237 ASM169857v1 GCA_001698575.1 2018-05-Ensembl/2018-07 N N N N N Y mola_mola_core_112_1 1 64.125000
oryzias_javanicus javanese ricefish EnsemblVertebrates NCBITaxon:123683 OJAV_1.1 GCA_003999625.1 2019-09-Ensembl/2019-11 N N N Y Y Y oryzias_javanicus_core_112_11 1 57.894737
meriones_unguiculatus mongolian gerbil EnsemblVertebrates NCBITaxon:10047 MunDraft-v1.0 GCA_002204375.1 2018-12-Ensembl/2020-03 N N N N N Y meriones_unguiculatus_core_112_1 1 57.142857

Standardize Organism identifiers

Let us generate a DataFrame that stores a number of Organism identifiers, some of which corrupted:

df_orig = pd.DataFrame(
    index=[
        "spiny chromis",
        "silver-eye",
        "platyfish",
        "california sea lion",
        "This organism does not exist",
    ]
)
df_orig
spiny chromis
silver-eye
platyfish
california sea lion
This organism does not exist

We can check whether any of our values are validated against the ontology reference:

validated = organisms.validate(df_orig.index, organisms.name)
df_orig.index[~validated]
! 1 unique term (20.00%) is not validated: 'This organism does not exist'
Index(['This organism does not exist'], dtype='object')

Ontology source versions

For any given entity, we can choose from a number of versions:

bt.Source.filter(entity="bionty.Organism").df()
Hide code cell output
uid entity organism name version in_db currently_used description url md5 source_website dataframe_artifact_id run_id created_at created_by_id
id
1 33TU bionty.Organism vertebrates ensembl release-112 False True Ensembl https://ftp.ensembl.org/pub/release-112/specie... 0ec37e77f4bc2d0b0b47c6c62b9f122d https://www.ensembl.org None None 2024-11-21 06:52:19.976422+00:00 1
2 1SRH bionty.Organism vertebrates ensembl release-111 False False Ensembl https://ftp.ensembl.org/pub/release-111/specie... 2846df83899eaa61f8043db4c036e883 https://www.ensembl.org None None 2024-11-21 06:52:19.976483+00:00 1
3 6I0P bionty.Organism vertebrates ensembl release-110 False False Ensembl https://ftp.ensembl.org/pub/release-110/specie... f3faf95648d3a2b50fd3625456739706 https://www.ensembl.org None None 2024-11-21 06:52:19.976517+00:00 1
4 2m0D bionty.Organism vertebrates ensembl release-109 False False Ensembl https://ftp.ensembl.org/pub/release-109/specie... 7595bb989f5fec07eaca5e2138f67bd4 https://www.ensembl.org None None 2024-11-21 06:52:19.976546+00:00 1
5 7MMd bionty.Organism vertebrates ensembl release-108 False False Ensembl https://ftp.ensembl.org/pub/release-108/specie... d97c1ee302e4072f5f5c7850eff0b642 https://www.ensembl.org None None 2024-11-21 06:52:19.976573+00:00 1
6 6bbV bionty.Organism bacteria ensembl release-57 False True Ensembl https://ftp.ensemblgenomes.ebi.ac.uk/pub/bacte... ee28510ed5586ea7ab4495717c96efc8 https://www.ensembl.org None None 2024-11-21 06:52:19.976600+00:00 1
7 6s9n bionty.Organism fungi ensembl release-57 False True Ensembl http://ftp.ensemblgenomes.org/pub/fungi/releas... dbcde58f4396ab8b2480f7fe9f83df8a https://www.ensembl.org None None 2024-11-21 06:52:19.976626+00:00 1
8 2PmT bionty.Organism metazoa ensembl release-57 False True Ensembl http://ftp.ensemblgenomes.org/pub/metazoa/rele... 424636a574fec078a61cbdddb05f9132 https://www.ensembl.org None None 2024-11-21 06:52:19.976650+00:00 1
9 7GPH bionty.Organism plants ensembl release-57 False True Ensembl https://ftp.ensemblgenomes.ebi.ac.uk/pub/plant... eadaa1f3e527e4c3940c90c7fa5c8bf4 https://www.ensembl.org None None 2024-11-21 06:52:19.976675+00:00 1
10 4tsk bionty.Organism all ncbitaxon 2023-06-20 False True NCBItaxon Ontology s3://bionty-assets/df_all__ncbitaxon__2023-06-... 00d97ba65627f1cd65636d2df22ea76c https://github.com/obophenotype/ncbitaxon None None 2024-11-21 06:52:19.976700+00:00 1
# only lists the sources that are currently used
bt.Source.filter(entity="bionty.Organism", currently_used=True).df()
uid entity organism name version in_db currently_used description url md5 source_website dataframe_artifact_id run_id created_at created_by_id
id
1 33TU bionty.Organism vertebrates ensembl release-112 False True Ensembl https://ftp.ensembl.org/pub/release-112/specie... 0ec37e77f4bc2d0b0b47c6c62b9f122d https://www.ensembl.org None None 2024-11-21 06:52:19.976422+00:00 1
6 6bbV bionty.Organism bacteria ensembl release-57 False True Ensembl https://ftp.ensemblgenomes.ebi.ac.uk/pub/bacte... ee28510ed5586ea7ab4495717c96efc8 https://www.ensembl.org None None 2024-11-21 06:52:19.976600+00:00 1
7 6s9n bionty.Organism fungi ensembl release-57 False True Ensembl http://ftp.ensemblgenomes.org/pub/fungi/releas... dbcde58f4396ab8b2480f7fe9f83df8a https://www.ensembl.org None None 2024-11-21 06:52:19.976626+00:00 1
8 2PmT bionty.Organism metazoa ensembl release-57 False True Ensembl http://ftp.ensemblgenomes.org/pub/metazoa/rele... 424636a574fec078a61cbdddb05f9132 https://www.ensembl.org None None 2024-11-21 06:52:19.976650+00:00 1
9 7GPH bionty.Organism plants ensembl release-57 False True Ensembl https://ftp.ensemblgenomes.ebi.ac.uk/pub/plant... eadaa1f3e527e4c3940c90c7fa5c8bf4 https://www.ensembl.org None None 2024-11-21 06:52:19.976675+00:00 1
10 4tsk bionty.Organism all ncbitaxon 2023-06-20 False True NCBItaxon Ontology s3://bionty-assets/df_all__ncbitaxon__2023-06-... 00d97ba65627f1cd65636d2df22ea76c https://github.com/obophenotype/ncbitaxon None None 2024-11-21 06:52:19.976700+00:00 1

When instantiating a Bionty object, we can choose a source or version:

source = bt.Source.filter(
    name="ensembl", version="release-110", organism="vertebrates"
).one()
organisms= bt.Organism.public(source=source)
organisms
PublicOntology
Entity: Organism
Organism: vertebrates
Source: ensembl, release-110
#terms: 317

The currently used ontologies can be displayed using:

bt.Source.filter(currently_used=True).df()
Hide code cell output
uid entity organism name version in_db currently_used description url md5 source_website dataframe_artifact_id run_id created_at created_by_id
id
1 33TU bionty.Organism vertebrates ensembl release-112 False True Ensembl https://ftp.ensembl.org/pub/release-112/specie... 0ec37e77f4bc2d0b0b47c6c62b9f122d https://www.ensembl.org None None 2024-11-21 06:52:19.976422+00:00 1
6 6bbV bionty.Organism bacteria ensembl release-57 False True Ensembl https://ftp.ensemblgenomes.ebi.ac.uk/pub/bacte... ee28510ed5586ea7ab4495717c96efc8 https://www.ensembl.org None None 2024-11-21 06:52:19.976600+00:00 1
7 6s9n bionty.Organism fungi ensembl release-57 False True Ensembl http://ftp.ensemblgenomes.org/pub/fungi/releas... dbcde58f4396ab8b2480f7fe9f83df8a https://www.ensembl.org None None 2024-11-21 06:52:19.976626+00:00 1
8 2PmT bionty.Organism metazoa ensembl release-57 False True Ensembl http://ftp.ensemblgenomes.org/pub/metazoa/rele... 424636a574fec078a61cbdddb05f9132 https://www.ensembl.org None None 2024-11-21 06:52:19.976650+00:00 1
9 7GPH bionty.Organism plants ensembl release-57 False True Ensembl https://ftp.ensemblgenomes.ebi.ac.uk/pub/plant... eadaa1f3e527e4c3940c90c7fa5c8bf4 https://www.ensembl.org None None 2024-11-21 06:52:19.976675+00:00 1
10 4tsk bionty.Organism all ncbitaxon 2023-06-20 False True NCBItaxon Ontology s3://bionty-assets/df_all__ncbitaxon__2023-06-... 00d97ba65627f1cd65636d2df22ea76c https://github.com/obophenotype/ncbitaxon None None 2024-11-21 06:52:19.976700+00:00 1
11 4UGN bionty.Gene human ensembl release-112 False True Ensembl s3://bionty-assets/df_human__ensembl__release-... 4ccda4d88720a326737376c534e8446b https://www.ensembl.org None None 2024-11-21 06:52:19.976726+00:00 1
15 4r4f bionty.Gene mouse ensembl release-112 False True Ensembl s3://bionty-assets/df_mouse__ensembl__release-... 519cf7b8acc3c948274f66f3155a3210 https://www.ensembl.org None None 2024-11-21 06:52:19.976826+00:00 1
19 4RPA bionty.Gene saccharomyces cerevisiae ensembl release-112 False True Ensembl s3://bionty-assets/df_saccharomyces cerevisiae... 11775126b101233525a0a9e2dd64edae https://www.ensembl.org None None 2024-11-21 06:52:19.976928+00:00 1
22 3EYy bionty.Protein human uniprot 2024-03 False True Uniprot s3://bionty-assets/df_human__uniprot__2024-03_... b5b9e7645065b4b3187114f07e3f402f https://www.uniprot.org None None 2024-11-21 06:52:19.977003+00:00 1
25 01RW bionty.Protein mouse uniprot 2024-03 False True Uniprot s3://bionty-assets/df_mouse__uniprot__2024-03_... b1b6a196eb853088d36198d8e3749ec4 https://www.uniprot.org None None 2024-11-21 06:52:19.977077+00:00 1
28 3kDh bionty.CellMarker human cellmarker 2.0 False True CellMarker s3://bionty-assets/human_cellmarker_2.0_CellMa... d565d4a542a5c7e7a06255975358e4f4 http://bio-bigdata.hrbmu.edu.cn/CellMarker None None 2024-11-21 06:52:19.977150+00:00 1
29 7bV5 bionty.CellMarker mouse cellmarker 2.0 False True CellMarker s3://bionty-assets/mouse_cellmarker_2.0_CellMa... 189586732c63be949e40dfa6a3636105 http://bio-bigdata.hrbmu.edu.cn/CellMarker None None 2024-11-21 06:52:19.977175+00:00 1
30 6LyR bionty.CellLine all clo 2022-03-21 False True Cell Line Ontology https://data.bioontology.org/ontologies/CLO/su... ea58a1010b7e745702a8397a526b3a33 https://bioportal.bioontology.org/ontologies/CLO None None 2024-11-21 06:52:19.977199+00:00 1
32 1Lhf bionty.CellType all cl 2024-05-15 False True Cell Ontology http://purl.obolibrary.org/obo/cl/releases/202... 8a8638a9e79567935793e5007704c650 https://obophenotype.github.io/cell-ontology None None 2024-11-21 06:52:19.977248+00:00 1
40 MUtA bionty.Tissue all uberon 2024-08-07 False True Uberon multi-species anatomy ontology http://purl.obolibrary.org/obo/uberon/releases... http://obophenotype.github.io/uberon None None 2024-11-21 06:52:19.977442+00:00 1
49 2L2r bionty.Disease all mondo 2024-06-04 False True Mondo Disease Ontology http://purl.obolibrary.org/obo/mondo/releases/... c47e8edb894c01f2511dfe0751fbc428 https://mondo.monarchinitiative.org None None 2024-11-21 06:52:19.977690+00:00 1
57 4ksw bionty.Disease human doid 2024-05-29 False True Human Disease Ontology http://purl.obolibrary.org/obo/doid/releases/2... bbefd72247d638edfcd31ec699947407 https://disease-ontology.org None None 2024-11-21 06:52:19.977884+00:00 1
65 2a1H bionty.ExperimentalFactor all efo 3.70.0 False True The Experimental Factor Ontology http://www.ebi.ac.uk/efo/releases/v3.70.0/efo.owl https://bioportal.bioontology.org/ontologies/EFO None None 2024-11-21 06:52:19.979985+00:00 1
72 48fB bionty.Phenotype human hp 2024-04-26 False True Human Phenotype Ontology https://github.com/obophenotype/human-phenotyp... e0f2e534eb2ad44a4d45573ef27b508f https://hpo.jax.org None None 2024-11-21 06:52:19.980163+00:00 1
77 4t7Q bionty.Phenotype mammalian mp 2024-06-18 False True Mammalian Phenotype Ontology https://github.com/mgijax/mammalian-phenotype-... 795d8378fe48ec13b41d01a86dd1c86c https://github.com/mgijax/mammalian-phenotype-... None None 2024-11-21 06:52:19.980284+00:00 1
80 sqPX bionty.Phenotype zebrafish zp 2024-04-18 False True Zebrafish Phenotype Ontology https://github.com/obophenotype/zebrafish-phen... 2231ebaa95becf8ff34a33c95a8d4350 https://github.com/obophenotype/zebrafish-phen... None None 2024-11-21 06:52:19.980360+00:00 1
84 6S4q bionty.Phenotype all pato 2024-03-28 False True Phenotype And Trait Ontology http://purl.obolibrary.org/obo/pato/releases/2... 6b1eaacd3d453b34375ce2e31c16328a https://github.com/pato-ontology/pato None None 2024-11-21 06:52:19.980455+00:00 1
86 7Ent bionty.Pathway all go 2024-06-17 False True Gene Ontology https://data.bioontology.org/ontologies/GO/sub... 7fa7ade5e3e26eab3959a7e4bc89ad4f http://geneontology.org None None 2024-11-21 06:52:19.980504+00:00 1
91 3rm9 BFXPipeline all lamin 1.0.0 False True Bioinformatics Pipeline s3://bionty-assets/df_all__lamin__1.0.0__BFXpi... https://lamin.ai None None 2024-11-21 06:52:19.980623+00:00 1
92 ugaI Drug all dron 2024-08-05 False True Drug Ontology https://data.bioontology.org/ontologies/DRON/s... https://bioportal.bioontology.org/ontologies/DRON None None 2024-11-21 06:52:19.980646+00:00 1
96 1GbF bionty.DevelopmentalStage human hsapdv 2024-05-28 False True Human Developmental Stages https://github.com/obophenotype/developmental-... https://github.com/obophenotype/developmental-... None None 2024-11-21 06:52:19.980741+00:00 1
98 10va bionty.DevelopmentalStage mouse mmusdv 2024-05-28 False True Mouse Developmental Stages https://github.com/obophenotype/developmental-... https://github.com/obophenotype/developmental-... None None 2024-11-21 06:52:19.980787+00:00 1
100 MJRq bionty.Ethnicity human hancestro 3.0 False True Human Ancestry Ontology https://github.com/EBISPOT/hancestro/raw/3.0/h... 76dd9efda9c2abd4bc32fc57c0b755dd https://github.com/EBISPOT/hancestro None None 2024-11-21 06:52:19.980835+00:00 1
101 5JnV BioSample all ncbi 2023-09 False True NCBI BioSample attributes s3://bionty-assets/df_all__ncbi__2023-09__BioS... 918db9bd1734b97c596c67d9654a4126 https://www.ncbi.nlm.nih.gov/biosample/docs/at... None None 2024-11-21 06:52:19.980859+00:00 1