Skip to content

Commit 361d63f

Browse files
authored
add metadata in provenance warning (#27)
1 parent 9e16389 commit 361d63f

File tree

2 files changed

+23
-1
lines changed

2 files changed

+23
-1
lines changed

book/how-to-guides/validate-metadata.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,15 @@
33

44
QIIME 2 will automatically validate a metadata file anytime it is used.
55
This will inform you of any errors in your metadata formatting, which you can then correct.
6-
To test this, you can use the `qiime metadata tabulate` command, which will read your metadata file and produce a nicely formatting view in a QIIME 2 {term}`Visualization`
6+
To test this, you can use the `qiime metadata tabulate` command, which will read your metadata file and produce a nicely formatting view in a QIIME 2 {term}`Visualization`.
7+
8+
```{admonition} Warning: Do not include confidential information in your metadata.
9+
:class: warning
10+
QIIME 2 goes to great lengths to ensure that your bioinformatics workflow will be reproducible.
11+
This includes recording information about your analysis inside of your Results' data provenance, and the recorded information includes metadata that you provided to run specific commands.
12+
For this and other reasons, we strongly recommend that you **never include confidential information, such as Personally Identifying Information (PII), in your QIIME 2 metadata**.
13+
**Because QIIME 2 stores metadata in your data provenance, confidential information that you use in a QIIME 2 analysis will persist in downstream Results.**
14+
15+
Instead of including confidential information in your metadata, you should encode it with variables that only authorized individuals have access to.
16+
For example, subject names should be replaced with anonymized subject identifiers before use with QIIME 2.
17+
```

book/references/metadata.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,17 @@ The following sections describe the formatting requirements for QIIME 2 metadata
1515
There is no universal standard for TSV files.
1616
It is important to adhere to the requirements described in this document to understand how QIIME 2 will interpret your metadata file's contents.
1717

18+
```{admonition} Warning: Do not include confidential information in your metadata.
19+
:class: warning
20+
QIIME 2 goes to great lengths to ensure that your bioinformatics workflow will be reproducible.
21+
This includes recording information about your analysis inside of your Results' data provenance, and the recorded information includes metadata that you provided to run specific commands.
22+
For this and other reasons, we strongly recommend that you **never include confidential information, such as Personally Identifying Information (PII), in your QIIME 2 metadata**.
23+
**Because QIIME 2 stores metadata in your data provenance, confidential information that you use in a QIIME 2 analysis will persist in downstream Results.**
24+
25+
Instead of including confidential information in your metadata, you should encode it with variables that only authorized individuals have access to.
26+
For example, subject names should be replaced with anonymized subject identifiers before use with QIIME 2.
27+
```
28+
1829
```{warning}
1930
Spreadsheet editors often have auto-correct or auto-format features that will modify your data without alerting you that changes will be made {cite}`Ziemann2016`.
2031
This is something that you need to watch out for when working with your metadata files in spreadsheet editors.

0 commit comments

Comments
 (0)