Skip to content

Update faq.md Add Missing Data FAQ - #15

Merged
DeondeJager merged 23 commits into
masterfrom
Update-FAQs-20251103
Aug 10, 2026
Merged

Update faq.md Add Missing Data FAQ#15
DeondeJager merged 23 commits into
masterfrom
Update-FAQs-20251103

Conversation

@DeondeJager

Copy link
Copy Markdown
Contributor
  • 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.
Comment thread docs/documentation/user-documentation/faq.md Outdated
Comment thread docs/documentation/user-documentation/faq.md Outdated
- 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would break up the three level descriptions into bullets

Comment thread docs/documentation/user-documentation/faq.md
- 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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/documentation/user-documentation/faq.md
DeondeJager and others added 2 commits February 23, 2026 10:57
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Comment thread docs/documentation/user-documentation/faq.md
Comment thread docs/documentation/user-documentation/faq.md Outdated
Comment thread docs/documentation/user-documentation/faq.md Outdated
Comment thread docs/documentation/user-documentation/faq.md Outdated
Comment thread docs/documentation/user-documentation/faq.md Outdated
DeondeJager and others added 3 commits February 23, 2026 11:17
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Comment thread docs/documentation/user-documentation/faq.md Outdated
Comment thread docs/documentation/user-documentation/faq.md Outdated
Comment thread docs/documentation/user-documentation/faq.md Outdated
Comment thread docs/documentation/user-documentation/faq.md Outdated

@DeondeJager DeondeJager left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made several changes based on feedback from @jfy133.

@DeondeJager
DeondeJager requested a review from jfy133 February 23, 2026 10:36
Comment thread docs/documentation/user-documentation/faq.md
Comment thread docs/documentation/user-documentation/faq.md Outdated
Comment thread docs/documentation/user-documentation/faq.md Outdated
Comment thread docs/documentation/user-documentation/faq.md Outdated
Comment thread docs/documentation/user-documentation/faq.md Outdated
Comment thread docs/documentation/user-documentation/faq.md Outdated
Comment thread docs/documentation/user-documentation/faq.md Outdated
Comment thread docs/documentation/user-documentation/faq.md Outdated
Comment thread docs/documentation/user-documentation/faq.md
Comment thread docs/documentation/user-documentation/faq.md
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Comment thread docs/documentation/user-documentation/faq.md Outdated
Comment thread docs/documentation/user-documentation/faq.md Outdated
Co-authored-by: Deon de Jager <dejager4@gmail.com>
Comment thread docs/documentation/user-documentation/faq.md
Move missing data explanation to top.
Comment thread docs/documentation/user-documentation/faq.md
Comment thread docs/documentation/user-documentation/faq.md
Comment thread docs/documentation/user-documentation/faq.md Outdated
Delete here.
Text moved to top of FAQ.
Comment thread docs/documentation/user-documentation/faq.md
Add link to MIxS enum for missing values.
Comment thread docs/documentation/user-documentation/faq.md Outdated
Comment thread docs/documentation/user-documentation/faq.md

@DeondeJager DeondeJager left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@DeondeJager

DeondeJager commented Aug 3, 2026

Copy link
Copy Markdown
Contributor Author

@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).

@DeondeJager

Copy link
Copy Markdown
Contributor Author

Closes #19

@DeondeJager
DeondeJager requested a review from vicyklee August 10, 2026 08:52
@DeondeJager
DeondeJager merged commit e33867d into master Aug 10, 2026
@DeondeJager
DeondeJager deleted the Update-FAQs-20251103 branch August 10, 2026 09:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants