annotate sortBed.xml @ 0:4fb5ea02b441 draft

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