README.rst 4 KB
Newer Older
Aaron's avatar
Aaron committed
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
==============================
          BEDTools         
==============================

Created by Aaron Quinlan Spring 2009.
Copyright 2009,2010,2001 Aaron Quinlan. All rights reserved.
Stable releases: http://code.google.com/p/bedtools
Repository:      https://github.com/arq5x/bedtools

Released under GNU public license version 2 (GPL v2).


Summary
-------
BEDTools is a collection of utilities for comparing, summarizing, and 
intersecting genomic features in BED, GTF/GFF, VCF and BAM formats. 


Manual
------
See the extensive PDF manual included at: http://code.google.com/p/bedtools/downloads/detail?name=BEDTools-User-Manual.v4.pdf.

This manual covers many common usage examples.  There are also examples available at:
http://code.google.com/p/bedtools/wiki/Usage
http://code.google.com/p/bedtools/wiki/UsageAdvanced

Installation
------------
Aaron's avatar
Aaron committed
29
30
31
32
33
34
35
36
  #  Unpack the source downloaded tarball.
  #  cd into the expanded folder.
  #  Type "make clean" and hit enter.
  #  Type "make all" and hit enter.
  #  If you encountered no errors, then all of the BED Tools should now be in bin/
	 If not, try to troubleshoot then email me: aaronquinlan at gmail dot com
  #  Copy the files in bin/ to ~/bin or if you have the privileges, to /usr/local/bin.
  #  Use the tools.
Aaron's avatar
Aaron committed
37
38
39
40
41


List of available tools
-----------------------

Aaron's avatar
Aaron committed
42
43
=========================  =======================================================================================================
Utility                    Description
Aaron's avatar
Aaron committed
44
=========================  =======================================================================================================
Aaron's avatar
Aaron committed
45
*intersectBed (BAM)*       Returns overlaps between two BED/GFF/VCF files. 
Aaron's avatar
Aaron committed
46
47
*pairToBed (BAM)*          Returns overlaps between a paired-end BED file and a regular BED/VCF/GFF file.
*bamToBed (BAM)*           Converts BAM alignments to BED6, BED12, or BEDPE format.
Aaron's avatar
Aaron committed
48
*bedToBam (BAM)*           Converts BED/GFF/VCF features to BAM format.
Aaron's avatar
Aaron committed
49
50
51
*bed12ToBed6*              Converts "blocked" BED12 features to discrete BED6 features.
*bedToIgv*                 Creates IGV batch scripts for taking multiple snapshots from BED/GFF/VCF features.
*coverageBed (BAM)*        Summarizes the depth and breadth of coverage of features in one BED versus features (e.g, "windows", exons, etc.) defined in another BED/GFF/VCF file. 
Aaron's avatar
Aaron committed
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
*genomeCoverageBed (BAM)*  Creates either a histogram, BEDGRAPH, or a "per base" report of genome coverage. 
*unionBedGraphs*           Combines multiple BedGraph files into a single file, allowing coverage/other comparisons between them. 
*annotateBed*              Annotates one BED/VCF/GFF file with overlaps from many others. 
*groupBy*                  Summarizes data in a file/stream based on common columns.
*overlap*                  Returns the number of bases pairs of overlap b/w two features on the same line.
*pairToPair *              Returns overlaps between two paired-end BED files. 
*closestBed*               Returns the closest feature to each entry in a BED/GFF/VCF file. 
*subtractBed*              Removes the portion of an interval that is overlapped by another feature. 
*windowBed (BAM)*          Returns overlaps between two BED/VCF/GFF files based on a user-defined window. 
*mergeBed*                 Merges overlapping features into a single feature. 
*complementBed*            Returns all intervals _not_ spanned by the features in a BED/GFF/VCF file. 
*fastaFromBed*             Creates FASTA sequences based on intervals in a BED/GFF/VCF file. 
*maskFastaFromBed*         Masks a FASTA file based on BED coordinates. 
*shuffleBed*               Randomly permutes the locations of a BED file among a genome. 
*slopBed*                  Adjusts each BED entry by a requested number of base pairs. 
*sortBed*                  Sorts a BED file by chrom, then start position. Other ways as well. 
*linksBed*                 Creates an HTML file of links to the UCSC or a custom browser. 
=========================  =======================================================================================================