annotate samtools_sort.xml @ 5:346239545aa0 draft

Uploaded tool xml with improved command line.
author devteam
date Thu, 16 Oct 2014 12:42:20 -0400
parents 1d317aeacef4
children 191cec7b989b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
1d317aeacef4 Uploaded tool version 1.0.3 for samtools 1.1
devteam
parents: 3
diff changeset
1 <tool id="samtools_sort" name="sort" version="1.0.3">
3
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
2 <requirements>
4
1d317aeacef4 Uploaded tool version 1.0.3 for samtools 1.1
devteam
parents: 3
diff changeset
3 <requirement type="package" version="1.1">samtools</requirement>
3
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
4 </requirements>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
5 <description>a BAM file</description>
5
346239545aa0 Uploaded tool xml with improved command line.
devteam
parents: 4
diff changeset
6 <version_command>samtools --version | head -n 1 | awk '{ print $2 }'</version_command>
346239545aa0 Uploaded tool xml with improved command line.
devteam
parents: 4
diff changeset
7 <command>samtools sort $sort_mode "${input1}" -o "${output1}" -O bam -T dataset</command>
346239545aa0 Uploaded tool xml with improved command line.
devteam
parents: 4
diff changeset
8 <stdio>
346239545aa0 Uploaded tool xml with improved command line.
devteam
parents: 4
diff changeset
9 <exit_code range="1:" level="fatal" description="Error" />
346239545aa0 Uploaded tool xml with improved command line.
devteam
parents: 4
diff changeset
10 </stdio>
3
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
11 <inputs>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
12 <param name="input1" type="data" format="bam" label="BAM File" />
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
13 <param name="sort_mode" type="select" label="Sort by ">
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
14 <option value="" selected="True">Chromosomal coordinates</option>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
15 <option value="-n">Read names</option>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
16 </param>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
17 </inputs>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
18 <outputs>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
19 <data name="output1" format="bam" />
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
20 </outputs>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
21 <tests>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
22 <test>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
23 <param name="input1" value="1.bam" ftype="bam" />
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
24 <output name="output1" file="1_sort.bam" ftype="bam" sort="True"/>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
25 </test>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
26 </tests>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
27 <help>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
28
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
29 **What it does**
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
30
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
31 This tool uses the SAMTools_ toolkit to sort alignments by leftmost coordinates or read names.
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
32
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
33 .. _SAMTools: http://samtools.sourceforge.net/samtools.shtml
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
34
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
35 ------
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
36
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
37 **Citation**
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
38
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
39 For the underlying tool, please cite `Li H, Handsaker B, Wysoker A, Fennell T, Ruan J, Homer N, Marth G, Abecasis G, Durbin R; 1000 Genome Project Data Processing Subgroup. The Sequence Alignment/Map format and SAMtools. Bioinformatics. 2009 Aug 15;25(16):2078-9. &lt;http://www.ncbi.nlm.nih.gov/pubmed/19505943&gt;`_
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
40
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
41 If you use this tool in Galaxy, please cite Blankenberg D, et al. *In preparation.*
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
42
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
43 </help>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
44 </tool>