annotate GEMBASSY-1.0.3/doc/text/gbaseentropy.txt @ 0:8300eb051bea draft

Initial upload
author ktnyt
date Fri, 26 Jun 2015 05:19:29 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
1 gbaseentropy
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
2 Function
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
3
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
4 Calculates and graphs the sequence conservation using Shanon uncertainty
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
5
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
6 Description
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
7
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
8 This function calculates and graphs the sequence conservation in regions
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
9 around the start/stop codons using Shanon uncertainty (entropy). Smaller
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
10 values resemble higher conservation where the minumum value is 0 and the
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
11 maximum value is 2. The entropy is typically the lowest around position 0
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
12 (start/stop codon position).
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
13
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
14 The entropy H at position i with distribution P(i) is calculated as follows:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
15 H(P(i)) = -sum(P(i,j) * log(2,P(i,j)))
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
16
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
17 G-language SOAP service is provided by the
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
18 Institute for Advanced Biosciences, Keio University.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
19 The original web service is located at the following URL:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
20
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
21 http://www.g-language.org/wiki/soap
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
22
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
23 WSDL(RPC/Encoded) file is located at:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
24
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
25 http://soap.g-language.org/g-language.wsdl
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
26
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
27 Documentation on G-language Genome Analysis Environment methods are
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
28 provided at the Document Center
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
29
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
30 http://ws.g-language.org/gdoc/
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
31
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
32 Usage
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
33
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
34 Here is a sample session with gbaseentropy
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
35
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
36 % gbaseentropy refseqn:NC_000913
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
37 Calculates and graphs the sequence conservation using Shanon uncertainty
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
38 (entropy)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
39 Program compseq output file (optional) [nc_000913.gbaseentropy]:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
40
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
41 Go to the input files for this example
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
42 Go to the output files for this example
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
43
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
44 Example 2
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
45
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
46 % gbaseentropy refseqn:NC_000913 -plot -graph png
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
47 Calculates and graphs the sequence conservation using Shanon uncertainty
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
48 (entropy)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
49 Created gbaseentropy.1.png
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
50
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
51 Go to the input files for this example
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
52 Go to the output files for this example
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
53
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
54 Command line arguments
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
55
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
56 Calculates and graphs the sequence conservation using Shanon uncertainty
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
57 (entropy)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
58 Version: EMBOSS:6.5.7.0 GEMBASSY:1.0.1
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
59
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
60 Standard (Mandatory) qualifiers (* if not always prompted):
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
61 [-sequence] seqall Nucleotide sequence(s) filename and optional
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
62 format, or reference (input USA)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
63 * -graph xygraph [$EMBOSS_GRAPHICS value, or x11] Graph type
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
64 (ps, hpgl, hp7470, hp7580, meta, cps, x11,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
65 tek, tekt, none, data, xterm, png, gif, svg)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
66 * -outfile outfile [*.gbaseentropy] Program compseq output file
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
67 (optional)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
68
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
69 Additional (Optional) qualifiers: (none)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
70 Advanced (Unprompted) qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
71 -position selection [start] Either 'start' (around start codon)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
72 or 'end' (around stop codon) to create the
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
73 PWM
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
74 -patlen integer [3] Length of oligomer to count (Any integer
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
75 value)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
76 -upstream integer [30] Length upstream of specified position
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
77 to create PWM (Any integer value)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
78 -downstream integer [30] Length downstream of specified position
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
79 to create PWM (Any integer value)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
80 -[no]accid boolean [Y] Include to use sequence accession ID as
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
81 query
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
82 -plot toggle [N] Include to plot result
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
83
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
84 Associated qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
85
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
86 "-sequence" associated qualifiers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
87 -sbegin1 integer Start of each sequence to be used
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
88 -send1 integer End of each sequence to be used
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
89 -sreverse1 boolean Reverse (if DNA)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
90 -sask1 boolean Ask for begin/end/reverse
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
91 -snucleotide1 boolean Sequence is nucleotide
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
92 -sprotein1 boolean Sequence is protein
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
93 -slower1 boolean Make lower case
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
94 -supper1 boolean Make upper case
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
95 -scircular1 boolean Sequence is circular
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
96 -sformat1 string Input sequence format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
97 -iquery1 string Input query fields or ID list
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
98 -ioffset1 integer Input start position offset
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
99 -sdbname1 string Database name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
100 -sid1 string Entryname
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
101 -ufo1 string UFO features
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
102 -fformat1 string Features format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
103 -fopenfile1 string Features file name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
104
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
105 "-graph" associated qualifiers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
106 -gprompt boolean Graph prompting
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
107 -gdesc string Graph description
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
108 -gtitle string Graph title
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
109 -gsubtitle string Graph subtitle
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
110 -gxtitle string Graph x axis title
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
111 -gytitle string Graph y axis title
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
112 -goutfile string Output file for non interactive displays
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
113 -gdirectory string Output directory
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
114
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
115 "-outfile" associated qualifiers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
116 -odirectory string Output directory
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
117
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
118 General qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
119 -auto boolean Turn off prompts
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
120 -stdout boolean Write first file to standard output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
121 -filter boolean Read first file from standard input, write
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
122 first file to standard output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
123 -options boolean Prompt for standard and additional values
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
124 -debug boolean Write debug output to program.dbg
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
125 -verbose boolean Report some/full command line options
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
126 -help boolean Report command line options and exit. More
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
127 information on associated and general
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
128 qualifiers can be found with -help -verbose
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
129 -warning boolean Report warnings
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
130 -error boolean Report errors
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
131 -fatal boolean Report fatal errors
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
132 -die boolean Report dying program messages
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
133 -version boolean Report version number and exit
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
134
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
135 Input file format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
136
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
137 The database definitions for following commands are available at
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
138 http://soap.g-language.org/kbws/embossrc
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
139
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
140 gbaseentropy reads one or more nucleotide sequences.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
141
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
142 Output file format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
143
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
144 The output from gbaseentropy is to a plain text file or the EMBOSS
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
145 graphics device.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
146
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
147 File: nc_000913.gbaseentropy
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
148
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
149 Sequence: NC_000913
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
150 -30,1.98284
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
151 -29,1.97873
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
152 -28,1.97692
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
153 -27,1.97595
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
154 -26,1.97094
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
155 -25,1.96777
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
156 -24,1.96272
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
157 -23,1.96288
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
158 -22,1.95707
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
159
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
160 [Part of this file has been deleted for brevity]
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
161
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
162 21,1.93528
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
163 22,1.94470
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
164 23,1.95204
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
165 24,1.93139
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
166 25,1.95640
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
167 26,1.95711
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
168 27,1.93785
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
169 28,1.96060
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
170 29,1.94316
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
171 30,1.92581
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
172
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
173
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
174 Data files
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
175
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
176 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
177
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
178 Notes
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
179
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
180 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
181
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
182 References
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
183
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
184 Arakawa, K., Mori, K., Ikeda, K., Matsuzaki, T., Konayashi, Y., and
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
185 Tomita, M. (2003) G-language Genome Analysis Environment: A Workbench
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
186 for Nucleotide Sequence Data Mining, Bioinformatics, 19, 305-306.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
187
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
188 Arakawa, K. and Tomita, M. (2006) G-language System as a Platform for
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
189 large-scale analysis of high-throughput omics data, J. Pest Sci.,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
190 31, 7.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
191
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
192 Arakawa, K., Kido, N., Oshita, K., Tomita, M. (2010) G-language Genome
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
193 Analysis Environment with REST and SOAP Web Service Interfaces,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
194 Nucleic Acids Res., 38, W700-W705.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
195
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
196 Warnings
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
197
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
198 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
199
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
200 Diagnostic Error Messages
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
201
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
202 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
203
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
204 Exit status
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
205
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
206 It always exits with a status of 0.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
207
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
208 Known bugs
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
209
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
210 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
211
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
212 See also
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
213
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
214 gbaseinformationcontent Calculates and graphs the sequence conservation
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
215 using information content
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
216 gbaserelativeentropy Calculates and graphs the sequence conservation
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
217 using Kullback-Leibler divergence (relative
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
218 entropy)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
219
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
220 Author(s)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
221
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
222 Hidetoshi Itaya (celery@g-language.org)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
223 Institute for Advanced Biosciences, Keio University
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
224 252-0882 Japan
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
225
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
226 Kazuharu Arakawa (gaou@sfc.keio.ac.jp)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
227 Institute for Advanced Biosciences, Keio University
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
228 252-0882 Japan
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
229
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
230 History
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
231
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
232 2012 - Written by Hidetoshi Itaya
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
233 2013 - Fixed by Hidetoshi Itaya
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
234
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
235 Target users
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
236
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
237 This program is intended to be used by everyone and everything, from
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
238 naive users to embedded scripts.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
239
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
240 Comments
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
241
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
242 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
243