README.md 3.14 KB
Newer Older
Aaron Quinlan's avatar
Aaron Quinlan committed
1
2
3
===================================================
bedtools - a swiss army knife for genome arithmetic         
===================================================
Aaron's avatar
Aaron committed
4

Aaron Quinlan's avatar
Aaron Quinlan committed
5
**Current version**: 2.18.2
6

arq5x's avatar
arq5x committed
7
8
Note
-------
Aaron Quinlan's avatar
Aaron Quinlan committed
9
10
11
Stable release for bedtools were formerly archived on Google Code. Unfortunately, the Google Code
downloads facility is shutting down; so henceforth, all source code and stable releases will be 
maintained via this Github repository.
Aaron's avatar
Aaron committed
12

arq5x's avatar
arq5x committed
13
14
15
Summary
-------
Collectively, the bedtools utilities are a swiss-army knife of tools for a wide-range of genomics analysis tasks. The most widely-used tools enable genome arithmetic: that is, set theory on the genome. For example, bedtools allows one to intersect, merge, count, complement, and shuffle genomic intervals from multiple files in widely-used genomic file formats such as BAM, BED, GFF/GTF, VCF.
Aaron's avatar
Aaron committed
16

arq5x's avatar
arq5x committed
17
While each individual tool is designed to do a relatively simple task (e.g., intersect two interval files), quite sophisticated analyses can be conducted by combining multiple bedtools operations on the UNIX command line.
Aaron's avatar
Aaron committed
18

arq5x's avatar
arq5x committed
19
20
21
22
23
24
25
26
27
28
29
30

Performance
-----------
As of version 2.18, ``bedtools`` is substantially more scalable thanks to improvements we have made in the algorithm used to process datasets that are pre-sorted
by chromosome and start position. As you can see in the plots below, the speed and memory consumption scale nicely
with sorted data as compared to the poor scaling for unsorted data. The current version of bedtools intersect is as fast as (or slightly faster) than the ``bedops`` package's ``bedmap`` which uses a similar algorithm for sorted data.  The plots below represent counting the number of intersecting alignments from exome capture BAM files against CCDS exons.
The alignments have been converted to BED to facilitate comparisons to ``bedops``. We compare to the bedmap ``--ec`` option because similar error checking is enforced by ``bedtools``.

![Speed Comparison](http://bedtools.readthedocs.org/en/latest/_images/speed-comparo.png)
![Memory Comparison](http://bedtools.readthedocs.org/en/latest/_images/memory-comparo.png)


arq5x's avatar
arq5x committed
31
32
Details
-------
arq5x's avatar
typo    
arq5x committed
33
First created through urgency and adrenaline by Aaron Quinlan Spring 2009. 
arq5x's avatar
arq5x committed
34
Maintained by the Quinlan Laboratory at the University of Virginia.
Aaron's avatar
Aaron committed
35

arq5x's avatar
arq5x committed
36
37
38
39
1. **Lead developers**:           Aaron Quinlan, Neil Kindlon
2. **Significant contributions**: Assaf Gordon, Royden Clark, John Marshall, Brent Pedersen, Ryan Dale
3. **Repository**:                https://github.com/arq5x/bedtools2
4. **Stable releases**:           https://github.com/arq5x/bedtools2/releases
arq5x's avatar
arq5x committed
40
5. **Documentation**:             http://bedtools.readthedocs.org
arq5x's avatar
arq5x committed
41
6. **License**:                   Released under GNU public license version 2 (GPL v2).
Aaron's avatar
Aaron committed
42
43


arq5x's avatar
arq5x committed
44
45
46
47
48
49
50
Citation
--------
*Please cite the following article if you use BEDTools in your research*:
  * Quinlan AR and Hall IM, 2010. BEDTools: a flexible suite of utilities for comparing genomic features. Bioinformatics. 26, 6, pp. 841–842. 

Also, if you use *pybedtools*, please cite the following.
  * Dale RK, Pedersen BS, and Quinlan AR. Pybedtools: a flexible Python library for manipulating genomic datasets and annotations. Bioinformatics (2011). doi:10.1093/bioinformatics/btr539
Aaron's avatar
Aaron committed
51