Update faq.md Add Missing Data FAQ - #15
Conversation
DeondeJager
commented
Nov 3, 2025
- Added section: How to fill in missing data.
- Populated the new section with information.
- Fixed a small typo.
- Added section: How to fill in missing data. - Populated the new section with information. - Fixed a small typo.
| - it can not be shared due to data agreement restrictions; | ||
| - it is not applicable to that particular field (e.g. it is a negative control and the field does not apply) | ||
| - Missing data should only be reported for **mandatory** fields, not for **recommended** or **optional** fields. For the latter two, simply leave the field blank if the (meta)data are missing. | ||
| - There are three levels at which you can report missing data, with an increasing amount of specificity for each: _**top level**_, _**lower level**_, and _**reporting level**_. Be as specific/granular as possible when reporting missing values. The _top level_ indicates that the data are missing, while the _lower-_ and _reporting_ levels give a reason (from the [controlled vocabulary](https://www.insdc.org/technical-specifications/missing-value-reporting/)) why the data are missing. |
There was a problem hiding this comment.
I would break up the three level descriptions into bullets
| - If using terms from the most granular level (_reporting level_), then exclude the _lower level_ term, as each _reporting level_ term is a "child" of the _lower level_, which can then be inferred based on the [table](https://www.insdc.org/technical-specifications/missing-value-reporting/). | ||
|
|
||
| ### Examples | ||
| - missing |
There was a problem hiding this comment.
And let's provide context for each example:
- How to encode missing info for a negative control (not applicable)
- How to encode missing info because the infromation was not collected during a historical sampling event, or the collection records burnt down
- How to encode missing information because native/indigenous groups do not permit sharing of this information
| - it can not be shared for privacy reasons; | ||
| - it can not be shared due to data agreement restrictions; | ||
| - it is not applicable to that particular field (e.g. it is a negative control and the field does not apply) | ||
| - Missing data should only be reported for **mandatory** fields, not for **recommended** or **optional** fields. For the latter two, simply leave the field blank if the (meta)data are missing. |
There was a problem hiding this comment.
I think the mandatory fields sentence should go at the beginning of this section in a preamble paragraph and say more along the lines of:
Fields in MIxS that are mandatory always require something filled into the given metadata entry. If you do not have this information, you must encode this using the specific 'missing information' categories as below.
While optional fields in MIxS can be left blank, if you have a specific reason the information will never be able to be reported (see examples below), then it is good to use these missing data categories there also.
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
DeondeJager
left a comment
There was a problem hiding this comment.
Made several changes based on feedback from @jfy133.
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: Deon de Jager <dejager4@gmail.com>
Move missing data explanation to top.
Delete here. Text moved to top of FAQ.
Add link to MIxS enum for missing values.
DeondeJager
left a comment
There was a problem hiding this comment.
Implemented various changes suggested by @jfy133.
Also made some edits to align with v7.0.0 of MIxS, such as referring to the MIxS missing values enum.
|
@jfy133 Can we merge and close this branch? If there are more changes to be made, I'd prefer for them to be done in a new issue & branch, as this one is getting a bit messy and difficult to follow (for me at least). |
|
Closes #19 |