From b6341ea4c8e486acc75e68e62fed8a67720d3b5b Mon Sep 17 00:00:00 2001
From: Victor Lin <13424970+victorlin@users.noreply.github.com>
Date: Wed, 25 May 2022 16:07:06 -0700
Subject: [PATCH] Add README to describe example data files

---
 tests/functional/filter/data/README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 tests/functional/filter/data/README.md

diff --git a/tests/functional/filter/data/README.md b/tests/functional/filter/data/README.md
new file mode 100644
index 000000000..c78221f34
--- /dev/null
+++ 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`.