Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Who is the section 'Compliance with the MiAIRR Data Standard' in airr_schema_requirement_levels.rts for #806

Open
ustervbo opened this issue Oct 6, 2024 · 1 comment

Comments

@ustervbo
Copy link
Contributor

ustervbo commented Oct 6, 2024

The section 'Compliance with the MiAIRR Data Standard' in airr_schema_requirement_levels.rts defines what compliance means. However, it is not clear to me who the audience of the section is. To me it seems to be about the data deposited somewhere - it is either complaint or not, but then the 'Implementors of data entry interfaces' is a little confusing, so obviously it is a mixed audience.

The text is clear, I'm not just not sure it it is something I as a regular user should care about, so I am missing a bit of who should take note apart form the implementors of data entry interfaces.

This is the section in all its glory:

Compliance with the MiAIRR Data Standard
========================================

-  Compliance to the MiAIRR Data Standard is currently a binary state,
   i.e., a data either is or is not compliant, there are not "grades"
   of compliance. However, additional requirements for specific use
   cases might be defined in the future.
-  Data sets are considered MiAIRR-compliant ONLY IF all ``essential``
   and ``important`` fields are reported.
-  Note that ``important`` fields with NULL-LIKE values MUST NOT be
   dropped from a data set.
-  Implementors of data entry interfaces SHOULD NOT set the default
   value of ``important`` fields to NULL-LIKE values, i.e., users should
   be required to actively select the values.

@javh
Copy link
Contributor

javh commented Nov 4, 2024

From the call:

  • Rename header to "Compliance for a complete data set".
  • Move out to an individual file so it has its own toctree entry.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants