update text with terminal BX tag info

pdimens · Dec 12, 2024 · d2888c5 · d2888c5
1 parent 8981405
commit d2888c5
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/harpy/downsample.py b/harpy/downsample.py
@@ -40,7 +40,9 @@ def downsample(input, invalid, output_dir, prefix, downsample, random_seed, setu
     Downsample data by barcode
 
     Downsamples FASTQ or BAM file(s) by barcode in the `BX` tag to keep all reads
-    from `-d` barcodes. Input can be:
+    from `-d` barcodes. The `BX:Z` tag must be the **last tag** in either the BAM
+    or FASTQ file(s). If the `BX` tag isn't terminal, use `bx_to_end.py` (provided
+    by Harpy) to move the tag to the end. Input can be:
     - one BAM file
     - two FASTQ files (R1 and R2 of a paired-end read set)