Merge pull request #516 from chuckpr/partition-size-dist-doc

added epilog documentation for <base>.dist file produced by extract-part...
dib-lab · Jul 1, 2014 · c268b03 · c268b03
2 parents 5a6e03c + 18f49fd
commit c268b03
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,8 @@
+2014-06-20 Chuck Pepe-Ranney <chuck.peperanney@gmail.com>
+
+    * scripts/extract-partitions.py: added epilog documentation for 
+	<base>.dist columns.
+
 2014-06-20  Michael R. Crusoe <mcrusoe@msu.edu>
 
     * doc/release.txt: Add Coverity Scan to release checklist

diff --git a/scripts/extract-partitions.py b/scripts/extract-partitions.py
@@ -54,6 +54,11 @@ def get_parser():
         merge-partitions.py -k 20 example
         annotate-partitions.py -k 20 example tests/test-data/random-20-a.fa
         extract-partitions.py example random-20-a.fa.part
+
+        (extract-partitions.py will produce a partition size distribution
+        in <base>.dist. The columns are: (1) number of reads, (2) count
+        of partitions with n reads, (3) cumulative sum of partitions,
+        (4) cumulative sum of reads.)
     """
     parser = argparse.ArgumentParser(
         description="Separate sequences that are annotated with partitions "