← Back to branch summary

~ubuntu-branches/ubuntu/raring/bedtools/raring

« back to all changes in this revision

Viewing changes to docs/content/linksBed.rst

  • Committer: Package Import Robot
  • Author(s): Charles Plessy
  • Date: 2012-11-04 17:59:41 UTC
  • mfrom: (1.1.9)
  • Revision ID: package-import@ubuntu.com-20121104175941-hahqzy1w8uy650z0
Tags: 2.17.0-1
bb9012e Imported Upstream version 2.16.2.
9006b23 Imported Upstream version 2.17.0.
9112569 Documented BEDTools license as a whole.
325689c Removed Pre-Depends: dpkg (>= 1.15.6).
a781b14 Conforms with Policy 3.9.4.
84b1167 Use Debhelper 9. 
0bf572d Distribute the test suite.
422cd34 Bash completion for BEDTools.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/content/linksBed.rst
 
1
###############
 
2
5.16 linksBed
 
3
###############
 
4
Creates an HTML file with links to an instance of the UCSC Genome Browser for all features /
 
5
intervals in a file. This is useful for cases when one wants to manually inspect through a large set of
 
6
annotations or features.
 
7
 
 
8
==========================================================================
 
9
5.16.1 Usage and option summary
 
10
==========================================================================
 
11
Usage:
 
12
::
 
13
  linksBed [OPTIONS] -i <BED/GFF/VCF> > <HTML file>
 
14
  
 
15
===========================      ===============================================================================================================================================================================================================
 
16
 Option                           Description
 
17
===========================      ===============================================================================================================================================================================================================
 
18
**-base**                                        The "basename" for the UCSC browser. *Default: http://genome.ucsc.edu*                                  
 
19
**-org**                                             The organism (e.g. mouse, human). *Default: human*
 
20
**-db**                          The genome build. *Default: hg18*
 
21
===========================      ===============================================================================================================================================================================================================
 
22
 
 
23
 
 
24
 
 
25
 
 
26
==========================================================================
 
27
5.16.2 Default behavior
 
28
==========================================================================
 
29
By default, **linksBed** creates links to the public UCSC Genome Browser.
 
30
 
 
31
For example:
 
32
::
 
33
  head genes.bed
 
34
  chr21 9928613  10012791  uc002yip.1 0  -
 
35
  chr21 9928613  10012791  uc002yiq.1 0  -
 
36
  chr21 9928613  10012791  uc002yir.1 0  -
 
37
  chr21 9928613  10012791  uc010gkv.1 0  -
 
38
  chr21 9928613  10061300  uc002yis.1 0  -
 
39
  chr21 10042683 10120796  uc002yit.1 0  -
 
40
  chr21 10042683 10120808  uc002yiu.1 0  -
 
41
  chr21 10079666 10120808  uc002yiv.1 0  -
 
42
  chr21 10080031 10081687  uc002yiw.1 0  -
 
43
  chr21 10081660 10120796  uc002yix.2 0  -
 
44
 
 
45
  linksBed -i genes.bed > genes.html
 
46
  
 
47
When genes.html is opened in a web browser, one should see something like the following, where each
 
48
link on the page is built from the features in genes.bed:
 
49
 
 
50
 
 
51
 
 
52
 
 
53
 
 
54
==========================================================================
 
55
5.16.3 Creating HTML links to a local UCSC Browser installation
 
56
==========================================================================
 
57
Optionally, **linksBed** will create links to a local copy of the UCSC Genome Browser.
 
58
 
 
59
For example:
 
60
::
 
61
  head -3 genes.bed
 
62
  chr21 9928613 10012791 uc002yip.1 0 -
 
63
  chr21 9928613 10012791 uc002yiq.1 0 -
 
64
 
 
65
  linksBed -i genes.bed -base http://mirror.uni.edu > genes.html
 
66
  
 
67
One can point the links to the appropriate organism and genome build as well:
 
68
::
 
69
  head -3 genes.bed
 
70
  chr21 9928613 10012791 uc002yip.1 0 -
 
71
  chr21 9928613 10012791 uc002yiq.1 0 -
 
72
 
 
73
  linksBed -i genes.bed -base http://mirror.uni.edu -org mouse -db mm9 > genes.html
 
74