File: CompactToSAMMode.jsap

package info (click to toggle)
libgoby-java 3.3.1%2Bdfsg2-11
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 58,108 kB
  • sloc: java: 78,105; cpp: 5,011; xml: 3,170; python: 2,108; sh: 1,575; ansic: 277; makefile: 114
file content (72 lines) | stat: -rw-r--r-- 3,373 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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
<!--
  ~ Copyright (C) 2009-2011 Institute for Computational Biomedicine,
  ~                    Weill Medical College of Cornell University
  ~
  ~  This program is free software; you can redistribute it and/or modify
  ~  it under the terms of the GNU General Public License as published by
  ~  the Free Software Foundation; either version 3 of the License, or
  ~  (at your option) any later version.
  ~
  ~  This program is distributed in the hope that it will be useful,
  ~  but WITHOUT ANY WARRANTY; without even the implied warranty of
  ~  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  ~  GNU General Public License for more details.
  ~
  ~  You should have received a copy of the GNU General Public License
  ~  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  -->

<jsap>
    <parameters>
        <unflaggedOption>
            <id>input-basename</id>
            <required>true</required>
            <help>The compact alignment file to read as input.</help>
        </unflaggedOption>
        <flaggedOption>
            <id>output</id>
            <shortFlag>o</shortFlag>
            <longFlag>output</longFlag>
            <required>true</required>
            <help>The SAM/BAM output file to output to. Please note that if the file ends in .bam, a BAM file will be
                written, whereas if the file ends in .sam, a SAM file will be written instead.
            </help>
        </flaggedOption>
        <flaggedOption>
            <id>genome</id>
            <shortFlag>g</shortFlag>
            <longFlag>genome</longFlag>
            <required>true</required>
            <help>
                The input genome in either 'compact random-access-genome' format or 'fa + fa.fai' format.
                The random-access-genome file can be made from a fasta reference using the build-sequence-cache mode.
                If using the random-access-genome input, specify any one of the files in the random-access-genome.
                If using the '.fa + .fa.fai' input, specify the '.fa' file but make sure the '.fa.fai' file
                is located in the same directory.
                Using the random-access-genome format can be considerably faster, but uses more memory than using
                the picard indexed fasta file.
            </help>
        </flaggedOption>
        <flaggedOption>
            <id>include-reference-names</id>
            <shortFlag>r</shortFlag>
            <longFlag>include-reference-names</longFlag>
            <required>false</required>
            <help>When provided, only process reference identifiers listed in this comma separated list. 
                  To process only chromosome 19 and 1, if sequences are identified by 1 and 19, 
                  use: --include-reference-names 1,19
            </help>
        </flaggedOption>
        <flaggedOption>
            <id>quality-encoding</id>
            <longFlag>quality-encoding</longFlag>
            <required>false</required>
            <defaults>
                <string>Phred</string>
            </defaults>
            <help>The encoding for quality scores. The default quality encoding is set to Sanger as per BAM/SAM
                specification v1.4-r985. Valid encodings include Illumina, Sanger and Solexa.
            </help>
        </flaggedOption>
    </parameters>
</jsap>