File: index.rst

package info (click to toggle)
bedops 2.4.41%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 21,148 kB
  • sloc: ansic: 28,562; cpp: 15,359; sh: 2,704; makefile: 2,687; xml: 1,669; python: 1,582; csh: 823; perl: 365; java: 172
file content (290 lines) | stat: -rw-r--r-- 16,539 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
===================================================================================
BEDOPS: the fast, highly scalable and easily-parallelizable genome analysis toolkit
===================================================================================

**BEDOPS** is an open-source command-line toolkit that performs highly efficient and scalable Boolean and other set operations, statistical calculations, archiving, conversion and other management of genomic data of arbitrary scale. Tasks can be easily split by chromosome for distributing whole-genome analyses across a computational cluster.

You can read more about **BEDOPS** and how it can be useful for your research in the :ref:`Overview <overview>` documentation, as well as in the `original manuscript <http://bioinformatics.oxfordjournals.org/content/28/14/1919.abstract>`_.

|downloads|

|reference|

========
Citation
========

If you use **BEDOPS** in your research, please cite the following manuscript:

   Shane Neph, M. Scott Kuehn, Alex P. Reynolds, et al. **BEDOPS: high-performance genomic feature operations**. *Bioinformatics* (2012) 28 (14): 1919-1920. `doi: 10.1093/bioinformatics/bts277 <http://bioinformatics.oxfordjournals.org/content/28/14/1919.abstract>`_

========
Contents
========

.. toctree::
   :numbered:

   content/overview
   content/installation
   content/revision-history
   content/usage-examples
   content/performance
   content/reference
   content/summary
   content/release
   content/placeholder

.. |header| raw:: html

   <h1>BEDOPS: the fast, highly scalable and easily-parallelizable genome analysis toolkit</h1>

.. |about_html| raw:: html

   <br><strong>BEDOPS</strong> is an open-source command-line toolkit that performs highly efficient and scalable Boolean and other set operations, statistical calculations, archiving, conversion and other management of genomic data of arbitrary scale. Tasks can be easily split by chromosome for distributing whole-genome analyses across a computational cluster.

   <p>You can read more about <strong>BEDOPS</strong> and how it can be useful for your research in the <a href="content/overview.html">Overview</a> documentation, as well as in the <a href="http://bioinformatics.oxfordjournals.org/content/28/14/1919.abstract">original manuscript</a>.</p><br>

.. |quick_start| image:: assets/index/quick_start.png

.. |quick_start_html| raw:: html

   <br><img src="_static/quick_start.png" style="height:150px;">

.. |downloads| raw:: html

   <img src="_static/downloads_v3.png" style="height:36px; margin:0; width: auto !important;">
   <div class="index_cols">
      <div class="col_element">
         <img src="_static/linux_v2.png" style="height:26px; width: auto !important; margin-bottom:10px;">
         <ul style="list-style-type:square; font-size:smaller; margin-left:0; margin-right:0px; padding-right:0px; padding-left:20px;">
            <li><a href="https://github.com/bedops/bedops/releases/download/v2.4.41/bedops_linux_x86_64-v2.4.41.tar.bz2">x86-64 (64-bit)</a> binaries</li>
            <li><a href="content/installation.html#linux">Installation instructions</a> for Linux hosts</li>
         </ul>
      </div>
      <div class="col_element">
         <img src="_static/macosx_v2.png" style="height:26px; width: auto !important; margin-bottom:10px;">
         <ul style="list-style-type:square; font-size:smaller; margin-left:0; margin-right:0px; padding-right:0px; padding-left:20px;">
            <li><a href="https://github.com/bedops/bedops/releases/download/v2.4.41/BEDOPS.2.4.41.pkg.zip">Intel (64-bit, 10.10-10.15)</a> installer package</li>
            <li><a href="content/installation.html#mac-os-x">Installation instructions</a> for Mac OS X hosts</li>
         </ul>
      </div>
      <div class="col_element">
         <img src="_static/source_v2.png" style="height:26px; width: auto !important; margin-bottom:10px;">
         <ul style="list-style-type:square; font-size:smaller; margin-left:0; margin-right:0px; padding-right:0px; padding-left:20px;">
            <li><a href="https://github.com/bedops/bedops/archive/v2.4.41.tar.gz">Source code</a> (tar.gz)</li>
            <li><a href="https://github.com/bedops/bedops/archive/v2.4.41.zip">Source code</a> (zip)</li>
            <li><a href="content/installation.html#installation-via-source-code">Compilation instructions</a></li>
         </ul>
      </div>
   </div>

.. |downloads_png| image:: assets/index/downloads_v3.png
                   :height: 30px

.. |downloads_html| raw:: html

   <img src="_static/downloads_v3.png" style="height:36px;">

.. |linux_png| image:: assets/index/linux_v2.png
               :height: 26px

.. |linux_html| raw:: html

   <img src="_static/linux_v2.png" style="height:26px;">

.. |linux_downloads| raw:: html

   <ul style="list-style-type:square; font-size:smaller; margin:10px; padding:0;">
   <li><a href="https://github.com/bedops/bedops/releases/download/v2.4.41/bedops_linux_x86_64-v2.4.41.tar.bz2">x86-64 (64-bit)</a> binaries</li>
   <li><a href="content/installation.html#linux">Installation instructions</a> for Linux hosts</li>
   </ul>

.. |macosx_png| image:: assets/index/macosx_v2.png
                :height: 26px

.. |macosx_html| raw:: html

   <img src="_static/macosx_v2.png" style="height:26px;">

.. |macosx_downloads| raw:: html

   <ul style="list-style-type:square; font-size:smaller; margin:10px; padding:0;">
   <li><a href="https://github.com/bedops/bedops/releases/download/v2.4.41/BEDOPS.2.4.41.pkg.zip">Intel (64-bit, 10.10-10.14)</a> installer package</li>
   <li><a href="content/installation.html#mac-os-x">Installation instructions</a> for Mac OS X hosts</li>
   </ul>

.. |source_png| image:: assets/index/source_v2.png
                :height: 26px

.. |source_html| raw:: html

   <img src="_static/source_v2.png" style="height:26px;">

.. |source_downloads| raw:: html

   <ul style="list-style-type:square; font-size:smaller; margin:10px; padding:0;">
   <li><a href="https://github.com/bedops/bedops/archive/v2.4.41.tar.gz">Source code</a> (tar.gz)</li>
   <li><a href="https://github.com/bedops/bedops/archive/v2.4.41.zip">Source code</a> (zip)</li>
   <li><a href="content/installation.html#installation-via-source-code">Compilation instructions</a></li>
   </ul>

.. |reference| raw:: html

   <img src="_static/reference_v2.png" style="height:36px; margin:0; width:auto !important;">
   <div class="index_cols">
      <div class="col_element">
         <img src="_static/set_operations_v2.png" style="height:130px; margin:0; width:auto !important; margin-bottom:12px;">
         <ul style="list-style-type:square; font-size:smaller; margin-left:0; margin-right:2px; padding-right:0px; padding-left:20px;">
            <li><a href="content/reference/set-operations/bedops.html"><tt>bedops</tt></a> - apply set operations on any number of BED inputs</li>
            <li><a href="content/reference/set-operations/bedextract.html"><tt>bedextract</tt></a> - efficiently extract BED features</li>
            <li><a href="content/reference/set-operations/closest-features.html"><tt>closest-features</tt></a> - matches nearest features between BED files</li>
        </ul>
      </div>
      <div class="col_element">
         <img src="_static/statistics_v2.png" style="height:130px; margin:0; width:auto !important; margin-bottom:12px;">
         <ul style="list-style-type:square; font-size:smaller; margin-left:0; margin-right:2px; padding-right:0px; padding-left:20px;">
            <li><a href="content/reference/statistics/bedmap.html"><tt>bedmap</tt></a> - map overlapping BED elements onto target regions and optionally compute any number of common statistical operations</li>
         </ul>
      </div>
      <div class="col_element">
         <img src="_static/file_management_v2.png" style="height:130px; margin:0; width:auto !important; margin-bottom:12px;">
         <ul style="list-style-type:square; font-size:smaller; margin-left:0; margin-right:2px; padding-right:0px; padding-left:20px;">
            <li><a href="content/reference/file-management/sorting/sort-bed.html"><tt>sort-bed</tt></a> - apply lexicographical sort to BED data</li>
            <li><a href="content/reference/file-management/compression/starch.html"><tt>starch</tt></a> and <a href="content/reference/file-management/compression/unstarch.html"><tt>unstarch</tt></a> - compress and extract BED data</li>
            <li><a href="content/reference/file-management/compression/starchcat.html"><tt>starchcat</tt></a> - merge compressed archives</li>
            <li><a href="content/reference/file-management/compression/starchstrip.html"><tt>starchstrip</tt></a> - filter archive by chromosomes</li>
            <li><a href="content/reference/file-management/conversion.html">Conversion tools</a> - convert common genomic formats to BED</li>
         </ul>
      </div>
   </div>
   <div class="index_cols">
      <div class="col_element">
         <img src="_static/performance_v2.png" style="height:130px; margin:0; width:auto !important; margin-bottom:12px;">
         <ul style="list-style-type:square; font-size:smaller; margin:0; margin-right:2px; padding-right:0px; padding-left:20px;">
            <li>Parallel <a href="content/reference/file-management/conversion/parallel_bam2bed.html"><tt>bam2bed</tt></a> and <a href="content/reference/file-management/conversion/parallel_bam2starch.html"><tt>bam2starch</tt></a> - parallelized conversion and compression of BAM data</li>
            <li><a href="content/performance.html#set-operations-with-bedops">Set operations with <tt>bedops</tt></li>
            <li><a href="content/performance.html#compression-characteristics-of-starch">Compression characteristics of <tt>starch</tt></li>
            <li><a href="content/performance.html#independent-testing">Independent testing</a></li>
         </ul>
      </div>
      <div class="col_element">
          <img src="_static/toc_v2.png" style="height:130px; margin:0; width:auto !important; margin-bottom:12px;">
          <ul style="list-style-type:square; font-size:smaller; margin:0; margin-right:2px; padding-right:0px; padding-left:20px;">
             <li><a href="content/summary.html">Table summary</a> of <strong>BEDOPS</strong> toolkit</li>
             <li><a href="content/reference/file-management/compression/starch-specification.html">Starch v2.2</a> format specification</li>
             <li><a href="content/reference/set-operations/nested-elements.html">About nested elements</a>
             <li><a href="content/revision-history.html">Revision history</a></li>
             <li><a href="content/release.html">Github release instructions</a></li>
             <li><a href="https://github.com/bedops/bedops">Github repository</a></li>
          </ul>
      </div>
      <div class="col_element">
          <img src="_static/support_v2.png" style="height:130px; margin:0; width:auto !important; margin-bottom:12px;">
          <ul style="list-style-type:square; font-size:smaller; margin:0; margin-right:2px; padding-right:0px; padding-left:20px;">
             <li><a href="content/installation.html">How to install <strong>BEDOPS</strong></a></li>
             <li><a href="content/usage-examples.html">Usage examples</a> of <strong>BEDOPS</strong> tools in action</li>
             <li><a href="http://bedops.uwencode.org/forum/"><strong>BEDOPS</strong> user forum</a></li>
             <li><a href="http://groups.google.com/group/bedops-discuss"><strong>BEDOPS</strong> discusssion mailing list</a></li>
          </ul>
      </div>
   </div>

.. |reference_png| image:: assets/index/reference_v2.png
                   :height: 36px

.. |reference_html| raw:: html

   <img src="_static/reference_v2.png" style="height:36px;">

.. |set_operations_png| image:: assets/index/set_operations_v2.png
                        :height: 130px

.. |set_operations_html| raw:: html

   <img src="_static/set_operations_v2.png" style="height:130px;">

.. |set_operations| raw:: html

   <ul style="list-style-type:square; font-size:smaller; margin:10px; padding:0;">
   <li><a href="content/reference/set-operations/bedops.html"><tt>bedops</tt></a> - apply set operations on any number of BED inputs</li>
   <li><a href="content/reference/set-operations/bedextract.html"><tt>bedextract</tt></a> - efficiently extract BED features</li>
   <li><a href="content/reference/set-operations/closest-features.html"><tt>closest-features</tt></a> - matches nearest<br/>features between BED files</li>
   </ul>

.. |statistics_png| image:: assets/index/statistics_v2.png
                    :height: 130px

.. |statistics_html| raw:: html

   <img src="_static/statistics_v2.png" style="height:130px;">

.. |statistics| raw:: html

   <ul style="list-style-type:square; font-size:smaller; margin:10px; padding:0;">
   <li><a href="content/reference/statistics/bedmap.html"><tt>bedmap</tt></a> - map overlapping BED elements onto target regions and optionally compute any number of common statistical operations</li>
   </ul>

.. |file_management_png| image:: assets/index/file_management_v2.png
                         :height: 130px

.. |file_management_html| raw:: html

   <img src="_static/file_management_v2.png" style="height:130px;">

.. |file_management| raw:: html

   <ul style="list-style-type:square; font-size:smaller; margin:10px; padding:0;">
   <li><a href="content/reference/file-management/sorting/sort-bed.html"><tt>sort-bed</tt></a> - apply lexicographical sort to BED data</li>
   <li><a href="content/reference/file-management/compression/starch.html"><tt>starch</tt></a> and <a href="content/reference/file-management/compression/unstarch.html"><tt>unstarch</tt></a> - compress and extract BED data</li>
   <li><a href="content/reference/file-management/compression/starchcat.html"><tt>starchcat</tt></a> - merge compressed archives</li>
   <li><a href="content/reference/file-management/compression/starchstrip.html"><tt>starchstrip</tt></a> - filter archives by chromosome names</li>
   <li><a href="content/reference/file-management/conversion.html">Conversion tools</a> - convert common genomic formats to BED</li>
   </ul>

.. |performance_png| image:: assets/index/performance_v2.png

.. |performance_html| raw:: html

   <img src="_static/performance_v2.png" style="height:130px;">

.. |performance| raw:: html

   <ul style="list-style-type:square; font-size:smaller; margin:10px; padding:0;">
   <li>Parallel <a href="content/reference/file-management/conversion/parallel_bam2bed.html"><tt>bam2bed</tt></a> and <a href="content/reference/file-management/conversion/parallel_bam2starch.html"><tt>bam2starch</tt></a> - parallelized conversion and compression of BAM data</li>
   <li><a href="content/performance.html#set-operations-with-bedops">Set operations with <tt>bedops</tt></li>
   <li><a href="content/performance.html#compression-characteristics-of-starch">Compression characteristics of <tt>starch</tt></li>
   <li><a href="content/performance.html#independent-testing">Independent testing</a></li>
   </ul>

.. |support_png| image:: assets/index/support_v2.png

.. |support_html| raw:: html

   <img src="_static/support_v2.png" style="height:130px;">

.. |support| raw:: html

   <ul style="list-style-type:square; font-size:smaller; margin:10px; padding:0;">
   <li><a href="content/installation.html">How to install <strong>BEDOPS</strong></a></li>
   <li><a href="content/usage-examples.html">Usage examples</a> of <strong>BEDOPS</strong> tools in action</li>
   <li><a href="http://bedops.uwencode.org/forum/"><strong>BEDOPS</strong> user forum</li>
   <li><a href="http://groups.google.com/group/bedops-discuss"><strong>BEDOPS</strong> discusssion mailing list</li>
   </ul>

.. |other_png| image:: assets/index/toc_v2.png

.. |other_html| raw:: html

   <img src="_static/toc_v2.png" style="height:130px;">

.. |other| raw:: html

   <ul style="list-style-type:square; font-size:smaller; margin:10px; padding:0;">
   <li><a href="content/summary.html">Table summary</a> of <strong>BEDOPS</strong> toolkit</li>
   <li><a href="content/reference/file-management/compression/starch-specification.html">Starch v2.2</a> format specification</li>
   <li><a href="content/reference/set-operations/nested-elements.html">About nested elements</a>
   <li><a href="content/revision-history.html">Revision history</a></li>
   <li><a href="content/release.html">Github release instructions</a></li>
   <li><a href="https://github.com/bedops/bedops">Github repository</a></li>
   </ul>