airr-community / airr-standards

AIRR Community Data Standards
https://docs.airr-community.org
Creative Commons Attribution 4.0 International
35 stars 23 forks source link

Clarification and Reorganization of High-Level Categories in `miairr/data_elements` #795

Open ustervbo opened 1 month ago

ustervbo commented 1 month ago

In the miairr/data_elements.rst, we mention having six high-level categories: Study and subject, sample collection, sample processing and sequencing, raw sequences, processing of sequence data, and processed AIRR sequences. However, the table only presents five levels:

At first, it look like 5/data (processed sequence) should be 6/data (processed sequence), but looking at the TSV-file I see that 5/data (processed sequence) is all about registering the V(D)J germline reference database, which aligns it with 5/process (computational) as it is relevant for the software registered in Software tools and version numbers.

Is splitting the table in miairr/data_elements.rst into sections corresponding to each high-level category possible? This will prevent endless scrolling and make the grouping more clear. And we can explain the occult and enigmatic 6th level.

javh commented 1 month ago

From the call: