annotate bamsort.xml @ 0:099d2c4d8007 draft

Imported from capsule None
author wolma
date Sat, 13 Dec 2014 17:19:46 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
1 <tool id="bamsort" name="Sort BAM file">
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
2 <description>Sort a BAM file by coordinates (or names) of the mapped reads</description>
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
3 <requirements>
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
4 <requirement type="package" version="0.1.5">mimodd</requirement>
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
5 </requirements>
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
6 <version_command>mimodd version -q</version_command>
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
7 <command>
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
8 mimodd sort $inputfile -o $output --oformat $oformat $by_name
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
9 </command>
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
10
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
11 <inputs>
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
12 <param name="inputfile" type="data" format="bam" label="Input file to sort" />
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
13 <param name="by_name" type="boolean" truevalue = "-n" falsevalue ="" label="Sort by read names instead of coordinates" checked = "false" help="A less common option, but necessary, e.g., if you want to re-align sorted output from a previous run of the Snap Align Tool." />
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
14 <param name="oformat" type="boolean" truevalue = "sam" falsevalue = "bam" label = "Output in uncompressed SAM format" checked = "false" />
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
15 </inputs>
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
16
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
17 <outputs>
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
18 <data name="output" format="bam" label="Sorted output from MiModd ${tool.name} on ${on_string}">
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
19 <change_format>
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
20 <when input="oformat" value="sam" format="sam" />
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
21 </change_format>
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
22 </data>
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
23 </outputs>
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
24
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
25 <help>
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
26 .. class:: infomark
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
27
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
28 **What it does**
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
29
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
30 The tool sorts a BAM file of aligned reads, typically by the reference genome coordinates that the reads have been mapped to.
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
31
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
32 Coordinate-sorted input files are expected by most downstream MiModD tools, but note that the *SNAP Read Alignment* produces coordinate-sorted output by default and it is only necessary to sort files that come from other sources or from *SNAP Read Alignment* jobs with a custom sort order.
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
33
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
34 The option *Sort by read names instead of coordinates* is useful if you want to re-align coordinate-sorted paired-end data. In *paired-end mode*, the *SNAP Read Alignment* tool expects the reads in the input file to be arranged in read pairs, i.e., the forward read information of a pair must be followed immediately by its reverse mate information, which is typically not the case in coordinate-sorted files. Resorting such files by read names fixes this problem.
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
35
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
36 </help>
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
37 </tool>
099d2c4d8007 Imported from capsule None
wolma
parents:
diff changeset
38