chanzuckerberg / single-cell-curation

Code and documentation for the curation of cellxgene datasets
MIT License
38 stars 23 forks source link

update schema definition to reference to ontology guide #836

Closed Bento007 closed 6 months ago

Bento007 commented 6 months ago

Motivation

The schema.md should be the source of truth for what is in the schema. Now that cellxgene-ontology-guide is used to track the ontology version used, it should be mentioned where it can be found and that it is used.

Definition of Done

Within the Required Ontologies section mention the locked version are in cellxgene-ontology-guide

brianraymor commented 6 months ago

I'm not sure that I fully understand the motivation.

There's never been a schema reference to the CLI which processed the "pinned" versions of ontology releases.

From my perspective, the schema defines requirements for COG similar to the requirements on the CLI. For example - chanzuckerberg/cellxgene-ontology-guide#80

Perhaps there should be a COG reference in the README.md in the single-cell-curation repo?

Bento007 commented 6 months ago

I'm not sure that I fully understand the motivation.

There's never been a schema reference to the CLI which processed the "pinned" versions of ontology releases.

From my perspective, the schema defines requirements for COG similar to the requirements on the CLI. For example - chanzuckerberg/cellxgene-ontology-guide#80

Perhaps there should be a COG reference in the README.md in the single-cell-curation repo?

I see, you want the schema to be updated first and everything else follow. We can close this.

Bento007 commented 6 months ago

As part of the migration process it should be documented that COG needs to be updated.

brianraymor commented 6 months ago

As part of the migration process it should be documented that COG needs to be updated.

Nit - but migration occurs after the CLI is updated. COG will be updated when the schema/CLI are updated - prior to migration.