DOC: add guidance on read length setting with Bracken (#105)

* add guidance on read length setting with Bracken This guidance is sourced from the [Bracken issue tracker](jenniferlu717/Bracken#234). * Update q2_moshpit/plugin_setup.py --------- Co-authored-by: Michal Ziemski <[email protected]>
bokulich-lab · Dec 8, 2023 · 3c1c8d6 · 3c1c8d6
1 parent 6e89666
commit 3c1c8d6
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/q2_moshpit/plugin_setup.py b/q2_moshpit/plugin_setup.py
@@ -202,7 +202,9 @@
     parameter_descriptions={
         'threshold': 'Bracken: number of reads required PRIOR to abundance '
                      'estimation to perform re-estimation.',
-        'read_len': 'Bracken: read length to get all classifications for.',
+        'read_len': ('Bracken: read length to get all classifications for. '
+                     'For paired end data (e.g., 2x150) this should be set '
+                     'to the length of the single-end reads (e.g., 150).'),
         'level': 'Bracken: taxonomic level to estimate abundance at.'
     },
     output_descriptions={