annotate sortBed.xml @ 54:b06c53665eb6 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
author iuc
date Tue, 23 Mar 2021 20:21:30 +0000
parents df28283b3778
children 7a06bb42dbb1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
1 <tool id="bedtools_sortbed" name="bedtools SortBED" version="@TOOL_VERSION@">
17
a2d4c30ba2f9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0887009a23d176b21536c9fd8a18c4fecc417d4f
iuc
parents: 8
diff changeset
2 <description>order the intervals</description>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
3 <macros>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
4 <import>macros.xml</import>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
5 </macros>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
6 <expand macro="requirements" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
7 <expand macro="stdio" />
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
8 <command><![CDATA[
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
9 sortBed
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
10 -i '$input'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
11 $option
54
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
12 @GENOME_FILE_MAPBED@
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
13 > '$output'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
14 ]]></command>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
15 <inputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
16 <param name="input" argument="-i" type="data" format="@STD_BEDTOOLS_INPUTS@" label="Sort the following @STD_BEDTOOLS_INPUT_LABEL@ file" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
17 <param name="option" type="select" label="Sort by">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
18 <!-- sort -k 1,1 -k2,2 -n a.bed -->
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
19 <option value="">chromosome, then by start position (asc)</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
20 <option value="-sizeA">feature size in ascending order.</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
21 <option value="-sizeD">feature size in descending order.</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
22 <option value="-chrThenSizeA">chromosome, then by feature size (asc).</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
23 <option value="-chrThenSizeD">chromosome, then by feature size (desc).</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
24 <option value="-chrThenScoreA">chromosome, then by score (asc).</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
25 <option value="-chrThenScoreD">chromosome, then by score (desc).</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
26 </param>
54
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
27 <expand macro="input_optional_genome_file" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
28 </inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
29 <outputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
30 <data name="output" format_source="input" metadata_source="input" label="SortBed on ${input.name}"/>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
31 </outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
32 <tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
33 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
34 <param name="input" value="sortBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
35 <param name="option" value="" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
36 <output name="output" file="sortBed_result1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
37 </test>
54
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
38 <test>
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
39 <param name="input" value="sortBed2.bed" ftype="bed" />
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
40 <param name="option" value="" />
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
41 <output name="output" file="sortBed_result2.bed" ftype="bed" />
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
42 </test>
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
43 <test>
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
44 <param name="input" value="sortBed2.bed" ftype="bed" />
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
45 <param name="option" value="" />
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
46 <param name="genome_choose" value="-g" />
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
47 <param name="genome_file_opts_selector" value="hist" />
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
48 <param name="genome" value="mm9.len" ftype="bed" />
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
49 <output name="output" file="sortBed_result3.bed" ftype="bed" />
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
50 </test>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
51 </tests>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
52 <help><![CDATA[
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
53 **What it does**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
54
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
55 Sorts a feature file by chromosome and other criteria.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
56
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
57
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
58 .. class:: warningmark
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
59
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
60 It should be noted that sortBed is merely a convenience utility, as the UNIX sort utility
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
61 will sort BED files more quickly while using less memory. For example, UNIX sort will sort a BED file
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
62 by chromosome then by start position in the following manner: sort -k 1,1 -k2,2 -n a.bed
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
63
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
64 @REFERENCES@
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
65 ]]></help>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
66 <expand macro="citations" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
67 </tool>