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