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

How will versioning work for AlleleDescription? #559

Closed schristley closed 1 year ago

schristley commented 2 years ago

The AlleleDescription schema supports a release_version which is important as curation/updating of germline genes will be an ongoing process for many species. However, some open questions remain regarding how to manage that provenance, and what that implies for AIRR objects that may reference or use the germline genes. Here are some questions that should be resolved and documented:

Depending upon the answers, we might add validation rules to enforce our decisions.

williamdlees commented 2 years ago

The germline set should contain one AlleleDescription for each allele. Mention in the description.

The rearrangement calls should reflect the label field in the AlleleDescripition.

The version number is updated under the control of the repository hosting the germline set. reflect discussion into AIRR standards coc: if someone copies a germline set they should put their own number on it, if they change it

Add validation code - >1 definiton of an allele in R and Python libraries

williamdlees commented 2 years ago

(closed in error)

williamdlees commented 1 year ago

Closed now the documentation is updated.