Skip to content

Commit

Permalink
Improved usage statement for starch-diff and updated revision history
Browse files Browse the repository at this point in the history
  • Loading branch information
alexpreynolds committed Jun 19, 2017
1 parent 96b625b commit 343ec7c
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
9 changes: 9 additions & 0 deletions applications/bed/starch/src/starch-diff.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,15 @@
help = """
The 'starch-diff' utility compares the signatures of two or more specified
Starch v2.2+ archives for all chromosomes, or for a specified chromosome.
The typical output of 'starch-diff' is a message indicating that the
archives’ chromosome(s) are identical or dissimilar, written to the standard
error stream.
In addition, if all chromosomes are identical, 'starch-diff' exits with a
zero status code. Likewise, if any chromosomes are dissimilar, 'starch-diff'
exits with a non-zero status code. This facilitates testing in a scripting
environment.
"""

default_chromosome = "all"
Expand Down
7 changes: 7 additions & 0 deletions docs/content/revision-history.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,16 @@ This revision of BEDOPS includes significant performance improvements for defaul

* New :code:`--min-memory` option for use when the reference file has very large regions, and the map file has many small regions that fall within those larger regions. One example is when :code:`--range 100000` is used and the map file consists of whole-genome motif scan hits.

* Added :code:`--faster` automatically when :code:`--exact` is used, to make more robust to nested elements.

* :ref:`closest-features <closest-features>`

* Performance of :code:`closest-features` tool increased by **1.1x** (or **9%**).

* :ref:`bam2bed <bam2bed>` and :ref:`sam2bed <sam2bed>`

* Increased thread I/O heap buffer size to reduce likelihood of overflows while parsing reads from Nanopore and PacBio platforms.

* Added :code:`--split-with-deletions` option to split spliced junctions by :code:`N` and :code:`D` CIGAR operations. The :code:`--split` option now splits only on :code:`N` operations.

* :ref:`sort-bed <sort-bed>`
Expand All @@ -55,6 +58,10 @@ This revision of BEDOPS includes significant performance improvements for defaul
* Starch C++ API

* Fixed output from :code:`bedops -u` (multiset union) on two or more Starch archives, such that the remainder string was not being cleared correctly.

* :ref:`starch-diff <starch_diff>`

* Improved usage statement to clarify output (cf. `Issue 180 <https://github.com/bedops/bedops/issues/180>`_).

=================
Previous versions
Expand Down

0 comments on commit 343ec7c

Please sign in to comment.