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