annotate sortBed.xml @ 62:071c1c5d4bad draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 03a91f6c42c75dc36d09505c2e6a2236178e4695
author iuc
date Mon, 20 Feb 2023 21:48:16 +0000
parents 9f6bd4c9479f
children f6c88d2e9ae5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
62
071c1c5d4bad planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 03a91f6c42c75dc36d09505c2e6a2236178e4695
iuc
parents: 61
diff changeset
1 <tool id="bedtools_sortbed" name="bedtools SortBED" version="@TOOL_VERSION@+galaxy2" profile="@PROFILE@">
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>
59
539958feb49c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 500a03281ea704abc7a16d9af63d67dbdcc5cd0b"
iuc
parents: 57
diff changeset
6 <expand macro="bio_tools" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
7 <expand macro="requirements" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
8 <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
9 <command><![CDATA[
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
10 sortBed
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
11 -i '$input'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
12 $option
61
9f6bd4c9479f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit db0b91a784ca0c216345bc488d7d488babf1b53f"
iuc
parents: 59
diff changeset
13 @GENOME_FILE@
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
14 > '$output'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
15 ]]></command>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
16 <inputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
17 <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
18 <param name="option" type="select" label="Sort by">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
19 <!-- sort -k 1,1 -k2,2 -n a.bed -->
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
20 <option value="">chromosome, then by start position (asc)</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
21 <option value="-sizeA">feature size in ascending order.</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
22 <option value="-sizeD">feature size in descending order.</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
23 <option value="-chrThenSizeA">chromosome, then by feature size (asc).</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
24 <option value="-chrThenSizeD">chromosome, then by feature size (desc).</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
25 <option value="-chrThenScoreA">chromosome, then by score (asc).</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
26 <option value="-chrThenScoreD">chromosome, then by score (desc).</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
27 </param>
62
071c1c5d4bad planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 03a91f6c42c75dc36d09505c2e6a2236178e4695
iuc
parents: 61
diff changeset
28 <expand macro="input_conditional_genome_file" optional="true" help="Sort according to the chromosomes declared in a genome file" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
29 </inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
30 <outputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
31 <data name="output" format_source="input" metadata_source="input" label="SortBed on ${input.name}"/>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
32 </outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
33 <tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
34 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
35 <param name="input" value="sortBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
36 <param name="option" value="" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
37 <output name="output" file="sortBed_result1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
38 </test>
54
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
39 <test>
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="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
41 <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
42 <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
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 <test>
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="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
46 <param name="option" value="" />
61
9f6bd4c9479f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit db0b91a784ca0c216345bc488d7d488babf1b53f"
iuc
parents: 59
diff changeset
47 <conditional name="genome_file_opts">
9f6bd4c9479f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit db0b91a784ca0c216345bc488d7d488babf1b53f"
iuc
parents: 59
diff changeset
48 <param name="genome_file_opts_selector" value="hist" />
9f6bd4c9479f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit db0b91a784ca0c216345bc488d7d488babf1b53f"
iuc
parents: 59
diff changeset
49 <param name="genome" value="mm9.len" ftype="bed" />
9f6bd4c9479f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit db0b91a784ca0c216345bc488d7d488babf1b53f"
iuc
parents: 59
diff changeset
50 </conditional>
54
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
51 <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
52 </test>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
53 </tests>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
54 <help><![CDATA[
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
55 **What it does**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
56
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
57 Sorts a feature file by chromosome and other criteria.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
58
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
59
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
60 .. class:: warningmark
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
61
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
62 It should be noted that sortBed is merely a convenience utility, as the UNIX sort utility
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
63 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
64 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
65
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
66 @REFERENCES@
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
67 ]]></help>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
68 <expand macro="citations" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
69 </tool>