annotate mergeBed.xml @ 46:64e2edfe7a2c draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 3e7bf5ae62de3520635d75e3825701960b9722e4
author iuc
date Sat, 18 May 2024 23:28:38 +0000
parents 589e7e57fd6d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
39
3e38c9b3214f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 1e25e8d0bd1ebeb2b94c4bbdff222e56defc1fc2"
iuc
parents: 34
diff changeset
1 <tool id="bedtools_mergebed" name="bedtools MergeBED" version="@TOOL_VERSION@" profile="@PROFILE@">
4
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 3
diff changeset
2 <description>combine overlapping/nearby intervals into a single interval</description>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
3 <macros>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
4 <import>macros.xml</import>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
5 </macros>
41
7ab85ac5f64b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 500a03281ea704abc7a16d9af63d67dbdcc5cd0b"
iuc
parents: 39
diff changeset
6 <expand macro="bio_tools" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
7 <expand macro="requirements" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
8 <expand macro="stdio" />
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
9 <command><![CDATA[
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
10 mergeBed
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
11 -i '${input}'
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
12 $strand
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
13 -d $distance
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
14 $header
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
15 @C_AND_O_ARGUMENT@
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
16 > '${output}'
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
17 ]]></command>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
18 <inputs>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
19 <param name="input" argument="-i" type="data" format="bam,@STD_BEDTOOLS_INPUTS@" label="Sort the following BAM/@STD_BEDTOOLS_INPUT_LABEL@ file"/>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
20 <param name="strand" type="select" label="Calculation based on strandedness?">
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
21 <option value="" selected="true">Overlaps on either strand</option>
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
22 <option value="-s">Force strandedness. That is, only merge features that are the same strand (-s)</option>
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
23 <option value="-S +">Force merge for forward strand only (-S +)</option>
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
24 <option value="-S -">Force merge for reverse strand only (-S -)</option>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
25 </param>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
26 <param name="distance" argument="-d" type="integer" value="0"
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
27 label="Maximum distance between features allowed for features to be merged"
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
28 help="That is, overlapping and/or book-ended features are merged"/>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
29 <expand macro="print_header" />
3
2cd7e321d259 Uploaded
iuc
parents: 2
diff changeset
30 <expand macro="c_and_o_argument">
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
31 <param name="col" argument="-c" type="data_column" data_ref="input" label="Specify the column(s) that should be summarized" />
3
2cd7e321d259 Uploaded
iuc
parents: 2
diff changeset
32 </expand>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
33 </inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
34 <outputs>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
35 <data name="output" format="bed" metadata_source="input" label="Merged ${input.name}"/>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
36 </outputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
37 <tests>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
38 <test>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
39 <param name="input" value="mergedBed1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
40 <output name="output" file="mergedBed_result1.bed" ftype="bed" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
41 </test>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
42 <test>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
43 <param name="input" value="mergedBed2.bed" ftype="bed" />
44
589e7e57fd6d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 03a91f6c42c75dc36d09505c2e6a2236178e4695
iuc
parents: 41
diff changeset
44 <param name="strand" value="-s" />
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
45 <output name="output" file="mergedBed_result2.bed" ftype="bed" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
46 </test>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
47 <test>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
48 <param name="input" value="mergedBed3.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
49 <output name="output" file="mergedBed_result3.bed" ftype="bed" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
50 </test>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
51 <test>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
52 <param name="input" value="mergedBed4.bed" ftype="bed" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
53 <param name="distance" value="1000" />
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
54 <output name="output" file="mergedBed_result4.bed" ftype="bed" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
55 </test>
2
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
56 <test>
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
57 <param name="input" value="mergedBed4.bed" ftype="bed" />
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
58 <param name="distance" value="1000" />
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
59 <repeat name="c_and_o_argument_repeat">
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
60 <param name="col" value="1"/>
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
61 <param name="operation" value="count"/>
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
62 </repeat>
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
63 <output name="output" file="mergedBed_result5.bed" ftype="bed" />
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
64 </test>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
65 </tests>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
66 <help><![CDATA[
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
67 **What it does**
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
68
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
69 bedtools merge combines overlapping or "book-ended" features in an interval file into a single feature which spans all of the combined features.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
70
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
71
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
72 .. image:: $PATH_TO_IMAGES/merge-glyph.png
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
73
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
74
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
75 .. class:: warningmark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
76
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
77 bedtools merge requires that you presort your data by chromosome and then by start position.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
78
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
79
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
80 ==========================================================================
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
81 Default behavior
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
82 ==========================================================================
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
83 By default, ``bedtools merge`` combines overlapping (by at least 1 bp) and/or
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
84 bookended intervals into a single, "flattened" or "merged" interval.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
85
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
86 ::
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
87
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
88 $ cat A.bed
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
89 chr1 100 200
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
90 chr1 180 250
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
91 chr1 250 500
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
92 chr1 501 1000
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
93
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
94 $ bedtools merge -i A.bed
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
95 chr1 100 500
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
96 chr1 501 1000
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
97
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
98
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
99 ==========================================================================
2
457b09031d57 Uploaded
iuc
parents: 1
diff changeset
100 *-s* Enforcing "strandedness"
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
101 ==========================================================================
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
102 The ``-s`` option will only merge intervals that are overlapping/bookended
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
103 *and* are on the same strand.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
104
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
105 ::
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
106
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
107 $ cat A.bed
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
108 chr1 100 200 a1 1 +
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
109 chr1 180 250 a2 2 +
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
110 chr1 250 500 a3 3 -
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
111 chr1 501 1000 a4 4 +
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
112
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
113 $ bedtools merge -i A.bed -s
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
114 chr1 100 250 +
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
115 chr1 501 1000 +
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
116 chr1 250 500 -
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
117
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
118
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
119 ==========================================================================
11
7308cc546a36 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 4
diff changeset
120 *-d* Controlling how close two features must be in order to merge
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
121 ==========================================================================
11
7308cc546a36 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 4
diff changeset
122 By default, only overlapping or book-ended features are combined into a new
7308cc546a36 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 4
diff changeset
123 feature. However, one can force ``merge`` to combine more distant features
7308cc546a36 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 4
diff changeset
124 with the ``-d`` option. For example, were one to set ``-d`` to 1000, any
7308cc546a36 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 4
diff changeset
125 features that overlap or are within 1000 base pairs of one another will be
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
126 combined.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
127
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
128 ::
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
129
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
130 $ cat A.bed
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
131 chr1 100 200
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
132 chr1 501 1000
11
7308cc546a36 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 4
diff changeset
133
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
134 $ bedtools merge -i A.bed
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
135 chr1 100 200
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
136 chr1 501 1000
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
137
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
138 $ bedtools merge -i A.bed -d 1000
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
139 chr1 100 200 1000
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
140
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
141
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
142 @REFERENCES@
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
143 ]]></help>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
144 <expand macro="citations" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
145 </tool>