HumanCellAtlas / metadata-schema

This repo is for the metadata schemas associated with the HCA
Apache License 2.0
65 stars 32 forks source link

Update project tab with four metadata entities for grouping Tissue Atlas projects #1517

Closed Wkt8 closed 1 year ago

Wkt8 commented 1 year ago

For which schema is a change/update being suggested?

Create a new 'hca_bionetwork' module and add it to project.json

What should the change/update be?

Creating four fields as part of the 'hca_bionetwork' module and adding them to project.json

1. HCA Bionetworks

I would like to add a new field - Project.hca_bionetwork.name - to this schema. This will allow data contributors to denote if the project is part of a HCA bionetwork and if so, which one.

This update constitutes a minor change to the schema(s) it affects.

Field name: project.hca_bionetwork.name
Field description: A field describing if the project is part of an HCA Bionetwork (e.g. Kidney). Enter ‘No’ if the project is not part of an HCA Bionetwork
Field type: array
Required: no
Examples: Kidney; Lung; No
CV or enum: enum

2. HCA Tissue Atlas

I would like to add a new field - Project.hca_bionetwork.hca_tissue_atlas - to this schema. This will allow data contributors to denote if the project is part of a HCA Tissue Atlas and if so, which one. In this case, a Tissue Atlas represents a singular h5ad file.

This update constitutes a minor change to the schema(s) it affects.

Field name: project.hca_bionetwork.hca_tissue_atlas
Field description: A field describing if the project is part of a HCA Tissue Atlas (e.g. Kidney). 
Field type: string, array
Required: no
Examples: Brain Alzheimer's Atlas 
CV or enum: Free Text

3. HCA Tissue Atlas Version

I would like to add a new field - Project.hca_bionetwork.hca_tissue_atlas_version - to this schema. This will allow data contributors to denote what version of the Tissue Atlas is associated with this publication (e.g. v1.0; v2.0)

This update constitutes a minor change to the schema(s) it affects.

Field name: project.hca_bionetwork.hca_tissue_atlas_version
Field description: A field describing the version of the HCA Tissue Atlas is associated with the publication (e.g. v1.0; v2.0)
Field type: string, array
Required: no
Examples: 'v1.0; v2.0'
CV or enum: REGEX

2. Integrated project

I would like to add a new field - Project.hca_bionetwork.atlas_project - to this schema. This will allow data contributors to denote if the publication is the HCA Tissue Atlas publication which integrates data from other projects within the atlas.

This update constitutes a minor change to the schema(s) it affects.

Field name: project.hca_bionetwork.atlas_project
Field description: A field describing if the project integrates data from other publications. 
Enter ‘Yes’ if this project is a HCA Tissue Atlas and it integrates data from all other datasets. Enter ‘No’, if this project's data is being integrated.
Field type: string
Required: no
Examples: 'Yes; No'
CV or enum: enum

Motivation

Biological Network Data Contributors need to be able to denote if a) Their project is part of a HCA Bionetwork b) Their project is part of a HCA Tissue Atlas c) What version of the HCA Tissue Atlas the project is a part of b) Whether the project is the 'Atlas Project' which draws data from other projects, or the project is a project from which data is being integrated

Wkt8 commented 1 year ago

After a meeting with Gabby, Dave, Will, Parisa, Ida and Wei an executive decision was made to add four fields to the Project module. Edited the issue accordingly.