annotate sortBed.xml @ 5:b78d20957e7f draft

Uploaded
author bernhardlutz
date Thu, 05 Jun 2014 15:25:18 -0400
parents
children c782e0edc4f1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
1 <tool id="bedtools_sortbed" name="Sort BED files" version="0.2.0">
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
2 <description></description>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
3 <macros>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
4 <import>macros.xml</import>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
5 </macros>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
6 <expand macro="requirements" />
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
7 <expand macro="stdio" />
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
8 <command>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
9 sortBed -i $input $option &gt; $output
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
10 </command>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
11 <inputs>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
12 <param format="bed" name="input" type="data" label="Sort the following BED file"/>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
13 <param name="option" type="select" label="Sort by">
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
14 <!-- sort -k 1,1 -k2,2 -n a.bed -->
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
15 <option value="">chromosome, then by start position (asc)</option>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
16 <option value="-sizeA">feature size in ascending order.</option>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
17 <option value="-sizeD">feature size in descending order.</option>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
18 <option value="-chrThenSizeA">chromosome, then by feature size (asc).</option>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
19 <option value="-chrThenSizeD">chromosome, then by feature size (desc).</option>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
20 <option value="-chrThenScoreA">chromosome, then by score (asc).</option>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
21 <option value="-chrThenScoreD">chromosome, then by score (desc).</option>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
22 </param>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
23 </inputs>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
24
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
25 <outputs>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
26 <data format="bed" name="output" metadata_source="input" label="${input.name} (as BED)"/>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
27 </outputs>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
28
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
29 <help>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
30
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
31 **What it does**
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
32
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
33 Sorts a feature file by chromosome and other criteria.
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
34
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
35
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
36 .. class:: warningmark
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
37
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
38 It should be noted that sortBed is merely a convenience utility, as the UNIX sort utility
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
39 will sort BED files more quickly while using less memory. For example, UNIX sort will sort a BED file
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
40 by chromosome then by start position in the following manner: sort -k 1,1 -k2,2 -n a.bed
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
41
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
42 @REFERENCES@
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
43
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
44 </help>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
45 </tool>