Merge pull request #952: Add README to describe example data files

nextstrain · Jan 13, 2025 · 1843a9b · 1843a9b
2 parents d7d8973 + b6341ea
commit 1843a9b
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/tests/functional/filter/data/README.md b/tests/functional/filter/data/README.md
@@ -0,0 +1,22 @@
+# Test files for `augur filter`
+
+## Overview
+
+These files are provided for functional testing of `augur filter`.
+
+## Files
+
+- Data on 12 Zika sequences:
+    - `metadata.tsv`: File to be used with `augur filter --metadata`.
+    - `sequences.fasta`: File to be used with `augur filter --sequences`. If updated, please regenerate `sequence_index.tsv`.
+    - `priorities.tsv`: File to be used with `augur filter --priority`.
+    - `include.txt`: File to be used with `augur filter --include`.
+    - `sequence_index.tsv`: File to be used with `augur filter --sequence-index`. Generated using:
+
+        ```
+        augur index --sequences sequences.fasta --output sequence_index.tsv
+        ```
+
+- Data on 165 Tuberculosis sequences:
+    - `tb_metadata.tsv`: File to be used with `augur filter --metadata`.
+    - `tb.vcf.gz`: File to be used with `augur filter --sequences`.