Skip to content

A Python tool to convert CEDAR metadata instances to CCF Biological Structure Ontology (CCF-BSO).

License

Notifications You must be signed in to change notification settings

metadatacenter-attic/cedar2ccf

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CEDAR-to-CCF

A Python tool to convert CEDAR metadata instances to CCF Biological Structure Ontology.

The CCF Biological Structure Ontology (CCF-BSO) models the relationship between a human cell type and its characterizing biomarkers. Each anatomical structure in the human body consists of different cell types and the same cell types might exist in multiple organ locations. The CCF-BSO makes the distinction between the cell types that are found in several locations by naming them differently, for example, the 'fibroblast' cell has various names such as "fibroblast of anterior cardiac vein", "fibroblast of coronary sinus", "fibroblast of epicardium", etc. The distinction is important in developing a human atlas because those cells may inherit different properties, such as their characterizing biomarkers.

The creation of the CCF-BSO starts by working with organ experts to manually construct the relevant partonomies of anatomical structure and describe the cell types present in the anatomical structure by presenting a set of their characterizing biomarkers (e.g., gene, protein, lipid and metabolite expression profiles). Additionally, the experts may add some publication DOIs that contain the conclusion about the cell type and its biomarkers. These acquired metadata are then converted into OWL axioms which are the building blocks of the CCF-BSO.

Acquiring the metadata using CEDAR and converting them to OWL axioms

The organ experts will use CEDAR during the data collection. Our team at Stanford has developed several metadata templates to accomodate the data collection for different major human organs (e.g., brain, heart, kidney, lung, etc.). The figure below shows an example of CEDAR metadata instance.

Screen Shot 2021-08-05 at 12 26 50 PM

CEDAR stores metadata instances in JSON-LD format and users are able to access their data on the Web via REST API. This Python tool utilizes this feature to convert the CEDAR metadata instances into OWL axioms to construct the CCF-BSO.

Screen Shot 2021-07-28 at 3 59 36 PM

Installing the tool

You can install the application using pip after you clone the repository.

$ cd cedar2ccf
$ pip install .

Using the tool

  1. Set up the environment variables. Follow the instructions on this site to retrieve the CEDAR API key from your account.

    export CEDAR_USER_ID=<your-cedar-user-id>
    export CEDAR_API_KEY=<your-cedar-api-key>
    
  2. Create a text file containing a list of HuBMAP organ template IDs on CEDAR. You may need to request access to the HuBMAP project team to get these template IDs.

    $ vi templates.txt 
    
  3. Run the tool

    $ cedar2ccf templates.txt --ontology-iri http://purl.org/ccf/data/asctb.owl -o asctb.owl
    
  4. Open the resulting output file using Protégé

    Screen Shot 2021-08-05 at 12 53 31 PM

About

A Python tool to convert CEDAR metadata instances to CCF Biological Structure Ontology (CCF-BSO).

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages