annotate BEDTools-Version-2.14.3/README.rst @ 0:dfcd8b6c1bda

Uploaded
author aaronquinlan
date Thu, 03 Nov 2011 10:25:04 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
1 ==============================
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
2 BEDTools
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
3 ==============================
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
4
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
5 Created by Aaron Quinlan Spring 2009.
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
6
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
7 Copyright 2009,2010,2011 Aaron Quinlan. All rights reserved.
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
8
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
9 Stable releases: http://code.google.com/p/bedtools
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
10
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
11 Repository: https://github.com/arq5x/bedtools
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
12
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
13 Released under GNU public license version 2 (GPL v2).
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
14
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
15
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
16 Summary
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
17 -------
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
18 BEDTools is a collection of utilities for comparing, summarizing, and
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
19 intersecting genomic features in BED, GTF/GFF, VCF and BAM formats.
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
20
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
21
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
22 Manual
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
23 ------
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
24 See the extensive PDF manual included at: http://code.google.com/p/bedtools/downloads/detail?name=BEDTools-User-Manual.v4.pdf.
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
25
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
26 This manual covers many common usage examples. There are also examples available at:
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
27 http://code.google.com/p/bedtools/wiki/Usage
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
28 http://code.google.com/p/bedtools/wiki/UsageAdvanced
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
29
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
30 Installation
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
31 ------------
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
32 Git
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
33 ...
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
34 git clone git://github.com/arq5x/bedtools.git
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
35
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
36 Download tarball - that big gray button on the upper right.
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
37 ...........................................................
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
38 #. Unpack the source downloaded tarball.
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
39 #. cd into the expanded folder.
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
40 #. Type "make clean" and hit enter.
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
41 #. Type "make all" and hit enter.
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
42 #. If you encountered no errors, then all of the BED Tools should now be in bin/
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
43 If not, try to troubleshoot then email me: aaronquinlan at gmail dot com
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
44 #. Copy the files in bin/ to ~/bin or if you have the privileges, to /usr/local/bin.
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
45 #. Use the tools.
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
46
dfcd8b6c1bda Uploaded
aaronquinlan
parents:
diff changeset
47