annotate weblogolib/htdocs/manual.html @ 14:778f03497adb

Uploaded
author davidmurphy
date Fri, 24 Feb 2012 11:37:26 -0500
parents c55bdc2fb9fa
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
2 "http://www.w3.org/TR/html4/transitional.dtd">
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
3 <html>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
4 <head>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
5 <link rel="stylesheet" type="text/css" href="logo.css" >
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
6 <title>CodonLogo - User's Manual</title>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
7 <meta name="author" content="Gavin E. Crooks" >
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
8
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
9 <style type="text/css">
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
10 </style>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
11 </head>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
12
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
13 <body style="align:center">
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
14
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
15 <table width="80%" border = '0' cellspacing='0' cellpadding='1' align="center">
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
16 <tr><td >
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
17 <h1>CodonLogo 1.0: User's Manual</h1>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
18
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
19 </td><td align = "right" >
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
20 &middot;
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
21 <a href="./">about</a>&nbsp;&middot;
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
22 <a href="create.cgi">create</a>&nbsp;&middot;
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
23 <a href="examples.html">examples</a>&nbsp;&middot;
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
24 <a class="selected" href="manual.html">manual</a>&nbsp;&middot;
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
25 <br>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
26 <span style="font-size:small">&nbsp;</span>&nbsp;&nbsp;
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
27
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
28 </td></tr>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
29
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
30 <tr><td colspan="2" class="discourse">
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
31
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
32 <h4>Contents</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
33
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
34 <img alt="Sequence logo example."
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
35 src="img/example.png" align="right" vspace="5" hspace="10">
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
36 <!--
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
37 <img alt="WebLogo: Create" width="499" height="633"
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
38 src="img/weblogo_create.png" align="right" border='1' vspace="10" hspace="10"></a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
39 -->
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
40
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
41 <ul>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
42 <li><a href="#intro">Introduction</a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
43 </li><li><a href="#create">Creating Sequences Logos using the Web interface</a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
44 </li><li><a href="#download">Downloading and Installing CodonLogo</a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
45 </li><li><a href="#CLI"> Command Line Interface (CLI)</a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
46 </li><li><a href="#API"> Application Programmer Interface (API)</a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
47 </li><li><a href="#dev"> Development and Future Features</a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
48 </li><li><a href="#misc">Miscellanea</a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
49 </li>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
50 </ul>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
51
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
52
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
53 <a name="intro" ></a><h2>Introduction</h2>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
54
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
55
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
56 <p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
57 <strong>CodonLogo</strong>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
58 is a web based application designed to make the
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
59 <a href="create.cgi">generation</a> of
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
60 codon sequence logos as easy and painless as possible.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
61 It is almost entirely based on the application WebLogo.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
62 </p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
63
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
64
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
65 <p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
66 <a href="http://www.lecb.ncifcrf.gov/~toms/sequencelogo.html">Sequence&nbsp;logos</a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
67 are a graphical representation of an amino acid
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
68 or nucleic acid multiple sequence alignment.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
69 Each logo consists of stacks of symbols, one stack for each position in the
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
70 sequence. The overall height of the stack indicates the sequence conservation
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
71 at that position, while the height of symbols within the stack indicates the
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
72 relative frequency of each amino or nucleic acid at that position. The width of the stack is proportional to the fraction of valid symbols in that position. (Positions with many gasp have thin stacks.) In general, a sequence logo provides a richer and more precise description of, for example,
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
73 a binding site, than would a consensus sequence.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
74 </p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
75
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
76
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
77
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
78
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
79
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
80
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
81
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
82 <!-- ============================================================== -->
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
83
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
84 <h4>References</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
85
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
86
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
87 <p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
88 <a href="http://bespoke.lbl.gov/">Crooks GE</a>,
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
89 <a href="http://compbio.berkeley.edu/">Hon G</a>,
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
90 <a href="http://compbio.berkeley.edu/">Chandonia JM</a>,
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
91 <a href="http://compbio.berkeley.edu/people/brenner/">Brenner SE</a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
92 WebLogo: A sequence logo
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
93 generator,
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
94 <em>Genome Research</em>, 14:1188-1190, (2004)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
95 [<a href="http://bespoke.lbl.gov/pubs/fulltext/Crooks2004a-GR-WebLogo.pdf">Full Text</a> ]
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
96 </p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
97
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
98 <p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
99 Schneider TD, Stephens RM. 1990.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
100 <a class="out" href="http://www.lecb.ncifcrf.gov/~toms/paper/logopaper/">Sequence Logos: A New Way to Display Consensus Sequences.</a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
101 <em>Nucleic Acids Res.</em> <em>18</em>:6097-6100
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
102 </p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
103
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
104
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
105
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
106
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
107
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
108
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
109
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
110 <a name="create" ></a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
111 <h2>Creating Sequences Logos using the Web interface</h2>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
112
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
113
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
114 <h4>Sequence Data</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
115 Enter your multiple sequence alignment here, or select a file to upload. Supported file formats include CLUSTALW, FASTA, plain flatfile, MSF, NBRF, PIR, NEXUS and PHYLIP. All sequences must be the same length, else CodonLogo will return an error and report the first sequence that differed in length from previous sequences.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
116
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
117 <h4>Output format</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
118
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
119 <ul>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
120 <li> PNG : (600 DPI) Print resolution bitmap
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
121 </li><li> PNG : (low res, 96 DPI) Screen resolution bitmap
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
122 </li><li> JPEG :Screen resolution bitmap
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
123 </li><li> EPS : Encapsulated postscript
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
124 </li><li> PDF : Portable Document Format
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
125 </li>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
126 </ul>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
127 Generally speaking, vector formats (EPS and PDF) are better for printing, while bitmaps (JPEG and PNG) are more suitable for displaying on the screen or embedding into a web page.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
128
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
129 <h4>Logo size</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
130 The physical dimensions of the generated logo.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
131 Specifically, controls the size of individual symbols stacks.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
132 <ul>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
133 <li> small : 5.4 points wide (Same as 9pt Courier), aspect ratio 5:1
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
134 </li><li> medium : Double the width and height of small.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
135 </li><li> large : Triple the width and height of small.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
136 </li>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
137 </ul>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
138 The choices have been limited to promote inter-logo consistency. Small logos can fit 80 stacks across a printed page, or 40 across a half page column. The <a href="#CLI">command line interface</a> provides greater control, if so desired.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
139
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
140 <h4>Stacks per line</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
141 If the length of the sequences is greater than this maximum number of stacks per line, then the logo will be split across multiple lines.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
142
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
143 <h4>Sequence type</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
144 The type of biological molecule.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
145 <ul>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
146 <li> auto: Automatically guess sequence type from the data
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
147 </li><li> protein
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
148 </li><li> dna
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
149 </li><li> rna
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
150 </li>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
151 </ul>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
152
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
153 <h4>Ignore lower case</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
154 Disregard lower case letters in the and only count
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
155 upper case letters in sequences?
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
156
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
157 <h4>Units</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
158 The units used for the y-axis.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
159 <ul>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
160 <li> probability: Show residue probabilities, rather than information content. If <a href="#CA">compositional adjustment</a> is disabled, then these are the raw residue frequencies.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
161 </li><li> bits: Information content in bits
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
162 </li><li> nats: Natural units, 1 bit = ln 2 (0.69) nats
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
163 </li><li> kT : Thermal energy units in natural units (Numerically the same as nats)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
164 </li><li> kJ/mol : Thermal energy (Assuming T = 300 K)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
165 </li><li> kcal/mol : Thermal energy (Assuming T = 300 K)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
166 </li>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
167 </ul>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
168
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
169
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
170 <h4>First position number</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
171 The numerical label of the first residue in the multiple sequence alignment. The label must be an integer. Residue labels for the logo will be relative to this number. (See also: Logo Range)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
172 <h4>Logo range</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
173 By default, all sequence data is displayed in the Sequence Logo. With this option, you can instead show a subrange of the entire sequence. Start and end positions are included, and the numbering of positions is relative to the sequence number of the first position. (See also: First Position Number ) Thus, if the first position number is "2", start is "5" and end is "10", then the 4th through 9th (inclusive) sequence positions will be displayed, and they will be numbered "5", "6", "7", "8", "9" and "10".
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
174
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
175 <a name="CA"></a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
176 <h4>Composition</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
177 <p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
178 The background composition of the genome or proteome from which the sequences have been drawn. The default, automatic option is to use equiprobable background for nucleic acids and a typical amino acid usage pattern for proteins. However, you may also explicitly set the expected CG content for nucleic acid sequences, insists on equiprobable background distributions, or turn off composition adjustment altogether.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
179 </p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
180 <p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
181 Compositional adjustment has two effects. First, the information content of a site is defined as the relative entropy of the monomers at that site to the background distribution. Consequentially, rare monomers have higher information content (when they occur) than relatively common monomers.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
182 </p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
183 <p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
184 Secondly, the background composition is used in the small sample correction of information content. Briefly, if only a few sequences are available in the multiple sequence alignment, then sites typically appear more conserved than they really are. Small samples bias the relative entropy upwards. To compensate, we add pseudocounts to the actual counts, proportional to the expected background composition. These pseudocounts smooth the data for small samples, but become irrelevant for large samples. The proportionality constant is set to 4 for nucleic acid sequences, and 20 for proteins (These numbers have been found to give reasonable results in practice).
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
185 </p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
186 <p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
187 Behind the scenes, things are more complex. We do a full Bayesian calculation, starting with explicit Dirichlet priors based on the background composition, to which we add the data and then calculate both the posterior mean relative entropy (the stack height) and Bayesian 95% confidence intervals for error bars. These interesting details will be explained elsewhere.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
188 </p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
189
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
190 <h4>Scale stack width</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
191 Scale the visible stack width by the fraction of symbols in the column? (i.e. columns with many gaps or unknown residues are narrow.)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
192
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
193 <h4>Error bars</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
194 Display error bars. These indicate an approximate, Bayesian 95% confidence interval.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
195
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
196 <h4>Title</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
197 Give your logo a title.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
198
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
199 <h4>Figure label</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
200 An optional figure label, added to the top left (e.g. '(a)')
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
201
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
202 <h4>X-axis</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
203 Add a label to the x-axis, or hide axis altogether.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
204
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
205 <h4>Y-axis</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
206 The vertical axis indicates the information content of a sequence position. Use this option to toggle the y-axis and override the default axis label.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
207
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
208 <h4>Y-axis scale</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
209 The height of the y-axis in designated units. The automatic option will pick reasonable defaults based on the sequence type and axis unit.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
210
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
211 <h4>Y-axis tic spacing</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
212 The distance between major tic marks on the Y-axis.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
213
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
214 <h4>Sequence end labels</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
215 Choose this option to label the 5' &amp; 3' ends of nucleic acid or the N &amp; C termini of amino acid sequences.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
216
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
217 <h4>Version fineprint</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
218 Toggle display of the CodonLogo version information in the lower right corner.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
219
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
220 <h4>Color Scheme</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
221 <ul>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
222 <li> auto : use Base Pairing for nucleic acids (NA), Hydrophobicity for amino acids (AA).
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
223 </li><li> monochrome: All symbols black
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
224 </li><li> Base Pairing (NA default) :
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
225 <table border="1" cellpadding="2" cellspacing="0" >
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
226 <tr><td>2 Watson-Crick hydrogen bonds</td><td>TAU</td><td style="color:darkorange">dark orange</td></tr>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
227 <tr><td>3 Watson-Crick hydrogen bonds</td><td>GC</td><td style="color:blue"> blue</td></tr>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
228 </table>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
229
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
230 </li><li> Classic (NA) : WebLogo (version 1 and 2) and makelogo default color scheme for nucleic acids: G, orange; T &amp; U, red; C, blue; and A, green.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
231 <table border="1" cellpadding="2" cellspacing="0" >
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
232 <tr><td>G</td><td style="color:orange"> orange</td></tr>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
233 <tr><td>TU</td><td style="color:red"> red</td></tr>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
234 <tr><td>C</td><td style="color:blue">blue</td></tr>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
235 <tr><td>A</td><td style="color:green">green</td></tr>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
236 </table>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
237
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
238 </li><li> Hydrophobicity (AA default) :
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
239 <table border="1" cellpadding="2" cellspacing="0" >
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
240 <tr><td>Hydrophobic</td><td>RKDENQ</td><td style="color:black"> black</td></tr>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
241 <tr><td>Neutral</td><td>SGHTAP</td><td style="color:green"> green</td></tr>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
242 <tr><td>Hydrophilic</td><td>YVMCLFIW</td><td style="color:blue">blue</td></tr>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
243 </table>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
244
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
245 </li><li> Chemistry (AA): Color amino acids according to chemical properties. WebLogo (version 1 and 2) and makelogo default color.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
246 <table border="1" cellpadding="2" cellspacing="0" >
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
247 <tr><td>Polar</td><td>G,S,T,Y,C,Q,N</td><td style="color:green"> green</td></tr>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
248 <tr><td>Basic</td><td>K,R,H</td><td style="color:blue"> blue</td></tr>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
249 <tr><td>Acidic</td><td>D,E</td><td style="color:red">red</td></tr>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
250 <tr><td>Hydrophobic</td><td>A,V,L,I,P,W,F,M</td><td style="color:black">black</td></tr>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
251 </table>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
252
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
253 </li><li> Charge (AA) :
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
254 <table border="1" cellpadding="2" cellspacing="0" >
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
255 <tr><td>Positive</td><td>KRH</td><td style="color:blue"> blue</td></tr>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
256 <tr><td>Negative</td><td>DE</td><td style="color:red"> red</td></tr>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
257 </table>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
258
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
259
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
260
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
261
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
262 </li><li> Custom : A custom color scheme can be specified in the input field below. Specify colors on the left and associated symbols on the right. Colors are entered using <a href="http://www.w3.org/TR/REC-CSS2/syndata.html#color-units">CSS2 (Cascading Style Sheet)</a> syntax. (e.g. 'red', '#F00', '#FF0000', 'rgb(255, 0, 0)', 'rgb(100%, 0%, 0%)' or 'hsl(0, 100%, 50%)' for the color red.)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
263 </li>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
264 </ul>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
265
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
266 <h4>More Options</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
267 The CodonLogo <a href="#CLI">command line client</a>, <code>codonlogo</code>, provides many more options and greater control over the final logo appearance.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
268
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
269
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
270
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
271
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
272
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
273
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
274 <!-- ========================================================= -->
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
275 <a name="download" ></a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
276 <h2>Installing CodonLogo</h2>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
277
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
278
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
279 <h4>Dependencies</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
280 <p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
281 CodonLogo is written in python. It is necessary to have <a href="http://www.python.org/download/">python 2.3, 2.4 or 2.5</a> and the
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
282 extension packages <a href="http://www.scipy.org/Download">numpy</a> and
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
283 <a href="http://code.google.com/p/corebio">corebio</a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
284 installed before WebLogo will run. WebLogo also requires a recent version of <a href="http://www.cs.wisc.edu/~ghost/">ghostscript</a> to create PNG and PDF output.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
285 </p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
286
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
287 <!--
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
288 <h4> Download and Installation</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
289 <p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
290 If the python package <a href="http://peak.telecommunity.com/DevCenter/setuptools"><code>setuptools</code></a> has been installed, then WebLogo and its dependancies can be downloaded and installed with a single command:
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
291 <pre>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
292 sudo easy_install weblogo
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
293 </pre>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
294 </p>-->
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
295 <!--
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
296 <p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
297 Alternatively, CodonLogo and its dependancies can be installed manually.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
298 The CodonLogo source code can be downloaded from
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
299 <a href="http://code.google.com/p/weblogo/">http://code.google.com/p/weblogo/</a>.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
300 This code is distributed under various <a href="http://www.opensource.org/docs/definition">open source licenses</a>. Please consult the <code>LICENSE.txt</code> file in the source distribution for details.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
301 </p>-->
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
302
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
303 <p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
304 After unpacking the CodonLogo tarfile, it should be possible to immediately create
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
305 logos using the command line client (Provided that python, numpy, corebio and ghostscript have already been installed).
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
306 </p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
307 <pre>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
308 ./codonlogo --format PNG &lt; htdocs/examples/cap_hth.fa &gt; cap_hth.png
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
309 </pre>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
310 <p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
311 Please consult the file <code>build_examples.sh</code> for more examples.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
312 </p><p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
313 To run CodonLogo as a stand alone web service, run the logo server command :
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
314 </p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
315 <pre>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
316 ./codonlogo --serve
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
317 </pre>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
318 <p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
319 It should now be possible to access CodonLogo at <a href="http://localhost:8080/">http://localhost:8080/</a>.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
320 </p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
321
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
322 <p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
323 The command line client and WebLogo libraries can be permanently installed using the supplied <code>setup.py</code> script.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
324 <pre>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
325 sudo python setup.py install
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
326 </pre>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
327 Run <code>python setup.py help</code> for more installation options. For example, to specifically install the CodonLogo script to /usr/local/bin
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
328 <pre>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
329 sudo python setup.py install_scripts --install-dir /usr/local/bin
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
330 </pre>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
331 </p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
332
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
333
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
334 </p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
335 <h4>Web App</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
336
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
337 <p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
338 To use CodonLogo as a web application, first install the weblogo dependancies and libraries as above, then
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
339 place (or link) the <code>weblogolib/weblogo_htdocs</code> directory
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
340 somewhere within the document root of your webserver. The webserver
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
341 must be able to execute the CGI script <code>create.cgi</code>. For Apache, you may have to add an <code>ExecCGI</code>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
342 option and add a cgi handler in the <code>httpd.conf</code> configuration file.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
343 Something like this:
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
344 </p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
345 <pre>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
346 &lt;Directory "/home/httpd/htdocs/weblogo/">
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
347 Options FollowSymLinks MultiViews ExecCGI
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
348 AllowOverride None
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
349 Order allow,deny
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
350 Allow from all
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
351 &lt;/Directory>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
352 ...
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
353 # To use CGI scripts outside of ScriptAliased directories:
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
354 # (You will also need to add "ExecCGI" to the "Options" directive.)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
355 #
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
356 AddHandler cgi-script .cgi
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
357 </pre>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
358 It may also be necessary to set the <code>PATH</code> and <code>PYTHONPATH</code> environment variables.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
359 <pre>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
360 SetEnv PYTHONPATH /path/to/weblogo/libraries
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
361 </pre>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
362 The cgi script also has to be able to find the '<code>gs</code>' ghostscript executable. If ghostscipt is installed in a non-standard location add the following environment variable.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
363 <pre>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
364 SetEnv COREBIOPATH /path/to/gs
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
365 </pre>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
366 The maxium bytes of uploaded sequecne data can be controlled with the <code>WEBLOGO_MAX_FILE_SIZE</code> environment variable.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
367 <pre>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
368 SetEnv WEBLOGO_MAX_FILE_SIZE 1000000
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
369 </pre>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
370
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
371
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
372
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
373
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
374 <!-- ================================================================== -->
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
375 <a name="CLI" ></a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
376 <h2><code>codonlogo</code>, The CodonLogo Command Line Interface (CLI)</h2>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
377 The command line client has many options not available through the web interface. Please consult the bundled <code>build_examples.sh</code> script for inspiration.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
378 <pre >
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
379 Usage: codonlogo [options] < sequence_data.fa > sequence_logo.eps
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
380
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
381 Create sequence logos from biological sequence alignments.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
382
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
383 Options:
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
384 --version show program's version number and exit
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
385 -h --help show this help message and exit
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
386
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
387 Input/Output Options:
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
388 -f --fin FILENAME Sequence input file (default: stdin)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
389 --fin-format FORMAT Multiple sequence alignment format: (clustal,
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
390 fasta, plain, msf, genbank, nbrf, nexus,
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
391 phylip, stockholm, intelligenetics, table,
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
392 array)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
393 -o --fout FILENAME Output file (default: stdout)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
394 -F --format FORMAT Format of output: eps (default), png,
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
395 png_print, pdf, jpeg, txt
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
396
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
397 Logo Data Options:
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
398 -A --sequence-type TYPE The type of sequence data: 'protein', 'rna' or
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
399 'dna'.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
400 -a --alphabet ALPHABET The set of symbols to count, e.g. 'AGTC'. All
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
401 characters not in the alphabet are ignored. If
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
402 neither the alphabet nor sequence-type are
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
403 specified then weblogo will examine the input
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
404 data and make an educated guess. See also
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
405 --sequence-type, --ignore-lower-case
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
406 --ignore-lower-case YES/NO
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
407 Disregard lower case letters and only count
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
408 upper case letters in sequences? (Default: No)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
409 -U --units NUMBER A unit of entropy ('bits' (default), 'nats',
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
410 'digits'), or a unit of free energy ('kT',
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
411 'kJ/mol', 'kcal/mol'), or 'probability' for
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
412 probabilities
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
413 --composition COMP. The expected composition of the sequences:
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
414 'auto' (default), 'equiprobable', 'none' (Do
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
415 not perform any compositional adjustment), a
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
416 CG percentage, a species name (e.g. 'E. coli',
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
417 'H. sapiens'), or an explicit distribution
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
418 (e.g. {'A':10, 'C':40, 'G':40, 'T':10}). The
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
419 automatic option uses a typical distribution
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
420 for proteins and equiprobable distribution for
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
421 everything else.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
422 --weight NUMBER The weight of prior data. Default: total
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
423 pseudocounts equal to the number of monomer
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
424 types.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
425 -i --first-index INDEX Index of first position in sequence data
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
426 (default: 1)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
427 -l --lower INDEX Lower bound of sequence to display
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
428 -u --upper INDEX Upper bound of sequence to display
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
429
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
430 Logo Format Options:
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
431 These options control the format and display of the logo.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
432
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
433 -s --size LOGOSIZE Specify a standard logo size (small, medium
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
434 (default), large)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
435 -n --stacks-per-line COUNT Maximum number of logo stacks per logo line.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
436 (default: 40)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
437 -t --title TEXT Logo title text.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
438 --label TEXT A figure label, e.g. '2a'
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
439 -X --show-xaxis YES/NO Display sequence numbers along x-axis?
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
440 (default: True)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
441 -x --xlabel TEXT X-axis label
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
442 -S --yaxis UNIT Height of yaxis in units. (Default: Maximum
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
443 value with uninformative prior.)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
444 -Y --show-yaxis YES/NO Display entropy scale along y-axis? (default:
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
445 True)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
446 -y --ylabel TEXT Y-axis label (default depends on plot type
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
447 and units)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
448 -E --show-ends YES/NO Label the ends of the sequence? (default:
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
449 False)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
450 -P --fineprint TEXT The fine print (default: weblogo version)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
451 --ticmarks NUMBER Distance between ticmarks (default: 1.0)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
452 --errorbars YES/NO Display error bars? (default: True)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
453
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
454 Color Options:
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
455 Colors can be specified using CSS2 syntax. e.g. 'red', '#FF0000', etc.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
456
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
457 -c --color-scheme SCHEME Specify a standard color scheme (auto, base
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
458 pairing, charge, chemistry, classic,
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
459 hydrophobicity, monochrome)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
460 -C --color COLOR SYMBOLS DESCRIPTION
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
461 Specify symbol colors, e.g. --color black AG
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
462 'Purine' --color red TC 'Pyrimidine'
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
463 --default-color COLOR Symbol color if not otherwise specified.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
464
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
465 Advanced Format Options:
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
466 These options provide fine control over the display of the logo.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
467
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
468 -W --stack-width POINTS Width of a logo stack (default: 10.8)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
469 -H --stack-height POINTS Height of a logo stack (default: 54.0)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
470 --box YES/NO Draw boxes around symbols? (default: no)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
471 --resolution DPI Bitmap resolution in dots per inch (DPI).
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
472 (default: 96 DPI, except png_print, 600 DPI)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
473 Low resolution bitmaps (DPI<300) are
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
474 antialiased.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
475 --scale-width YES/NO Scale the visible stack width by the fraction
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
476 of symbols in the column? (i.e. columns with
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
477 many gaps of unknowns are narrow.) (default:
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
478 yes)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
479 --debug YES/NO Output additional diagnostic information.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
480 (default: False)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
481
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
482 CodonLogo Server:
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
483 Run a standalone webserver on a local port.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
484
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
485 --serve Start a standalone CodonLogo server for creating
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
486 sequence logos.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
487 --port PORT Listen to this local port. (Default: 8080)
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
488 </pre >
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
489 <!-- ===================================================================== -->
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
490 <a name="API" ></a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
491 <h2>WebLogo Application Programmer Interface (API)</h2>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
492
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
493 The WebLogo python libraries provide even greater flexibility than the command line client. The code is split between two principle packages, <code>weblogo</code> itself, which contains specialized sequence logo generation code, and <code>corebio</code>, a package that contains code of more general utility.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
494 Please consult the <a href="http://weblogo.googlecode.com/svn/trunk/apidocs/index.html">WebLogo</a> and <a href="http://corebio.googlecode.com/svn/tags/0.5.0/apidocs/index.html">CoreBio</a> API documentation.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
495
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
496
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
497
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
498 <!-- ================================================================== -->
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
499 <a name="dev" ></a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
500 <h2>WebLogo Development and Future Features</h2>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
501 <p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
502 The development project is hosted at
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
503 <a href="http://code.google.com/p/weblogo/">http://code.google.com/p/weblogo</a>.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
504
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
505 If you wish to extend WebLogo or to contribute code, then you should download the full source code development package directly from the subversion repository.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
506 </p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
507 <pre>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
508 &gt; svn checkout http://weblogo.googlecode.com/svn/trunk/ weblogo
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
509 &gt; cd weblogo
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
510 &gt; ./weblogo &lt; cap.fa &gt; cap.eps
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
511 </pre>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
512 <p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
513 Please consult the developer notes, <code>DEVELOPERS.txt</code> and software license <code>LICENSE.txt</code>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
514 </p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
515
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
516 <p> Outstanding bugs and feature requests are listed on the <a href="http://code.google.com/p/weblogo/issues/list">WebLogo issue tracker.</a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
517 </p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
518
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
519 <a name="misc" ></a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
520 <h2>Miscellanea</h2>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
521 <h4> Release Notes and Known Bugs</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
522 The <a href="weblogo_changelog.txt">WebLogo release notes</a> detail changes to WebLogo and known issues with particular versions.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
523
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
524 <h4>WebLogo 2</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
525 The legacy WebLogo 2 sever can be found <a href="http://weblogo.berkeley.edu/">here.</a>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
526
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
527
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
528
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
529 <h4>Acknowledgments</h4>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
530
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
531 <p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
532 WebLogo was created by
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
533 <a href="http://threeplusone.com/">Gavin E. Crooks</a>,
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
534 <a href="http://compbio.berkeley.edu/">Liana Lareau</a>,
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
535 <a href="http://compbio.berkeley.edu/">Gary Hon</a>,
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
536 <a href="http://compbio.berkeley.edu/">John-Marc Chandonia</a> and
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
537 <a href="http://compbio.berkeley.edu/people/brenner/">Steven E. Brenner</a>.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
538 <a href="weblogo_changelog.txt">Many others</a> have provided suggestions, bug fixes and moral support.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
539 </p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
540
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
541 <p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
542 WebLogo was originally based upon the programs
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
543 <a href="http://www.lecb.ncifcrf.gov/~toms/delila/alpro.html">alpro</a> and
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
544 <a href="http://www.lecb.ncifcrf.gov/~toms/delila/makelogo.html">makelogo</a>,
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
545 both of which are part of Tom Schneider's
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
546 <a href="http://www.lecb.ncifcrf.gov/~toms/delila.html">delila</a> package. Many thanks
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
547 are due to him for making this software freely available and for encouraging its use.
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
548 </p>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
549
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
550
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
551
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
552
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
553
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
554 </td></tr>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
555 </table>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
556
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
557
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
558 <script type="text/javascript">
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
559 var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
560 document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
561 </script>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
562 <script type="text/javascript">
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
563 var pageTracker = _gat._getTracker("UA-5951066-1");
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
564 pageTracker._trackPageview();
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
565 </script>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
566 </body>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
567 </html>
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
568
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
569
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
570
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
571
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
572
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
573
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
574
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
575
c55bdc2fb9fa Uploaded
davidmurphy
parents:
diff changeset
576