HumanCellAtlas / metadata-schema

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

Re-assess cell_suspension.estimated_cell_count field name #1461

Open ESapenaVentura opened 2 years ago

ESapenaVentura commented 2 years ago

For which schema is a change/update being suggested?

I would like to request an update to the cell_suspension.json schema.

What should the change/update be?

I would like to update the cell_suspension.estimated_cell_count field to make it clearer for data consumers and contributors to know the intentions and differences behind this and the project.estimated_cell_count field

This was brought up in a DCP demo meeting, and the name is yet to be completely decided

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

Why is the change requested?

Data consumers need to provide with a clear indicator to the users about the data that is being extracted and shown from those fields Data users need clarity on disparity between the 2 fields

hannes-ucsc commented 2 years ago

For comparison, the property schema in the cell_suspension entity:

"estimated_cell_count": {
    "description": "Estimated number of cells in the suspension.",
    "type": "integer",
    "maximum": 1000000000,
    "minimum": 0,
    "example": "1; 2100",
    "user_friendly": "Estimated cell count",
    "guidelines": "Enter 1 for well-based assays."
},

and the project entity:

"estimated_cell_count": {
    "description": "An estimated number of cells in this project",
    "type": "integer",
    "example": "10000; 2100000",
    "user_friendly": "Estimated cell count"
}

It feels like cell_suspension.total_estimated_cells is actually named and described adequately, and that instead project.estimated_cell_count needs a better description and name. How about

"eventual_cell_count": {
    "description": "The approximate number of cells for which this project produced meaningful analysis results",
    "type": "integer",
    "example": "10000; 2100000",
    "user_friendly": "Eventual cell count"
}