File: starch-diff.rst

package info (click to toggle)
bedops 2.4.41%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 21,168 kB
  • sloc: ansic: 28,562; cpp: 15,359; sh: 2,704; makefile: 2,687; xml: 1,669; python: 1,581; csh: 823; perl: 365; java: 172
file content (52 lines) | stat: -rw-r--r-- 1,443 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
.. _starch_diff:

`starch-diff`
=============

This tool allows the end user to quickly compare the compressed chromosomes in two or more v2.2+ Starch archives.

==================
Inputs and outputs
==================

-----
Input
-----

The `starch-diff` utility takes in two or more Starch v2.2+ archives as input. The end user may also add `--chr <chr>` to compare one chromosome directly; otherwise, all chromosomes in specified archives are compared.

------
Output
------

The typical output of `starch-diff` is a message indicating the archives' chromosome(s) are identical or dissimilar. 

In addition, if the 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.

============
Requirements
============

If the user passes in a pre-v2.2 archive, the utility will exit with a fatal error.

=====
Usage
=====

Use the ``--help`` option to list all options:

::

    starch-diff
      citation: http://bioinformatics.oxfordjournals.org/content/28/14/1919.abstract
      version:  2.4.41
      authors:  Alex Reynolds and Shane Neph

      $ starch-diff [ --chr <chr> ] starch-file-1 starch-file-2 [ starch-file-3 ... ]

      The 'starch-diff' utility compares the signatures of two or more specified 
      Starch v2.2+ archives for all chromosomes, or for a specified chromosome.


.. role:: bash(code)
   :language: bash