annotate GEMBASSY-1.0.3/doc/text/gicdi.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 gicdi
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 the intrinsic codon deviation index (ICDI)
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 gicdi calculates the intrinsic codon deviation index (ICDI). ICDI is a
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
9 measure to estimate codon bias of genes from species in which optimal
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
10 codons are not known. It is known to show high correlation with other
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
11 indices such as CBI and ENC. A gene using only one codon for each amino
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
12 acid will have an ICDI of 1, and a gene using every codon equally for
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
13 each amino acid will have an ICDI of 0.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
14
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
15 G-language SOAP service is provided by the
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
16 Institute for Advanced Biosciences, Keio University.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
17 The original web service is located at the following URL:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
18
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
19 http://www.g-language.org/wiki/soap
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
20
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
21 WSDL(RPC/Encoded) file is located at:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
22
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
23 http://soap.g-language.org/g-language.wsdl
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
24
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
25 Documentation on G-language Genome Analysis Environment methods are
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
26 provided at the Document Center
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
27
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
28 http://ws.g-language.org/gdoc/
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
29
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
30 Usage
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
31
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
32 Here is a sample session with gicdi
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
33
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
34 % gicdi refseqn:NC_000913
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
35 Calculates the intrinsic codon deviation index (ICDI)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
36 Codon usage output file [nc_000913.gicdi]:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
37
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
38 Go to the input files for this example
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
39 Go to the output files for this example
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
40
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
41 Command line arguments
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
42
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
43 Standard (Mandatory) qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
44 [-sequence] seqall Nucleotide sequence(s) filename and optional
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
45 format, or reference (input USA)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
46 [-outfile] outfile [*.gicdi] Codon usage output file
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
47
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
48 Additional (Optional) qualifiers: (none)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
49 Advanced (Unprompted) qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
50 -translate boolean [N] Include when translating using standard
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
51 codon table
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
52 -delkey string [[^ACDEFGHIKLMNPQRSTVWYacgtU]] Regular
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
53 expression to delete key (Any string)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
54 -[no]accid boolean [Y] Include to use sequence accession ID as
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
55 query
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
56
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
57 Associated qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
58
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
59 "-sequence" associated qualifiers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
60 -sbegin1 integer Start of each sequence to be used
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
61 -send1 integer End of each sequence to be used
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
62 -sreverse1 boolean Reverse (if DNA)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
63 -sask1 boolean Ask for begin/end/reverse
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
64 -snucleotide1 boolean Sequence is nucleotide
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
65 -sprotein1 boolean Sequence is protein
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
66 -slower1 boolean Make lower case
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
67 -supper1 boolean Make upper case
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
68 -scircular1 boolean Sequence is circular
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
69 -sformat1 string Input sequence format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
70 -iquery1 string Input query fields or ID list
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
71 -ioffset1 integer Input start position offset
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
72 -sdbname1 string Database name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
73 -sid1 string Entryname
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
74 -ufo1 string UFO features
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
75 -fformat1 string Features format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
76 -fopenfile1 string Features file name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
77
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
78 "-outfile" associated qualifiers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
79 -odirectory2 string Output directory
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
80
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
81 General qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
82 -auto boolean Turn off prompts
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
83 -stdout boolean Write first file to standard output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
84 -filter boolean Read first file from standard input, write
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
85 first file to standard output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
86 -options boolean Prompt for standard and additional values
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
87 -debug boolean Write debug output to program.dbg
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
88 -verbose boolean Report some/full command line options
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
89 -help boolean Report command line options and exit. More
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
90 information on associated and general
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
91 qualifiers can be found with -help -verbose
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
92 -warning boolean Report warnings
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
93 -error boolean Report errors
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
94 -fatal boolean Report fatal errors
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
95 -die boolean Report dying program messages
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
96 -version boolean Report version number and exit
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
97
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
98 Input file format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
99
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
100 The database definitions for following commands are available at
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
101 http://soap.g-language.org/kbws/embossrc
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
102
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
103 gicdi reads one or more nucleotide sequences.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
104
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
105 Output file format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
106
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
107 The output from gicdi is to a plain text file.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
108
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
109 File: nc_000913.gicdi
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
110
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
111 Sequence: NC_000913
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
112 icdi,gene
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
113 0.8192,thrL
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
114 0.1258,thrA
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
115 0.1127,thrB
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
116 0.1689,thrC
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
117 0.3099,yaaX
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
118 0.2030,yaaA
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
119 0.1600,yaaJ
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
120 0.3533,talB
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
121
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
122 [Part of this file has been deleted for brevity]
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
123
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
124 0.2203,yjjX
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
125 0.2719,ytjC
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
126 0.1377,rob
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
127 0.2647,creA
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
128 0.1944,creB
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
129 0.1733,creC
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
130 0.1926,creD
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
131 0.2728,arcA
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
132 0.5171,yjjY
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
133 0.2434,yjtD
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
134
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
135
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
136 Data files
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
137
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
138 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
139
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
140 Notes
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
141
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
142 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
143
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
144 References
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
145
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
146 Comeron JM, Aguade M. (1998) An evaluation of measures of synonymous codon
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
147 usage bias, J Mol Evol, 47(3):268-74.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
148
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
149 Freire-Picos MA et al. (1994) Codon usage in Kluyveromyces lactis and in
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
150 yeast cytochrome c-encoding genes, Gene, 139:43-49.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
151
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
152 Arakawa, K., Mori, K., Ikeda, K., Matsuzaki, T., Konayashi, Y., and
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
153 Tomita, M. (2003) G-language Genome Analysis Environment: A Workbench
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
154 for Nucleotide Sequence Data Mining, Bioinformatics, 19, 305-306.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
155
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
156 Arakawa, K. and Tomita, M. (2006) G-language System as a Platform for
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
157 large-scale analysis of high-throughput omics data, J. Pest Sci.,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
158 31, 7.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
159
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
160 Arakawa, K., Kido, N., Oshita, K., Tomita, M. (2010) G-language Genome
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
161 Analysis Environment with REST and SOAP Web Service Interfaces,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
162 Nucleic Acids Res., 38, W700-W705.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
163
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
164 Warnings
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
165
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
166 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
167
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
168 Diagnostic Error Messages
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
169
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
170 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
171
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
172 Exit status
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
173
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
174 It always exits with a status of 0.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
175
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
176 Known bugs
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
177
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
178 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
179
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
180 See also
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
181
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
182 gcbi Calculates the codon bias index (CBI)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
183 gdeltaenc Calculate the codon usage bias related to translation optimization
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
184 (delta ENC)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
185 gsvalue Calculate the strength of selected codon usage bias (S)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
186
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
187 Author(s)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
188
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
189 Hidetoshi Itaya (celery@g-language.org)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
190 Institute for Advanced Biosciences, Keio University
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
191 252-0882 Japan
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
192
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
193 Kazuharu Arakawa (gaou@sfc.keio.ac.jp)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
194 Institute for Advanced Biosciences, Keio University
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
195 252-0882 Japan
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
196
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
197 History
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
198
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
199 2012 - Written by Hidetoshi Itaya
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
200 2013 - Fixed by Hidetoshi Itaya
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
201
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
202 Target users
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
203
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
204 This program is intended to be used by everyone and everything, from
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
205 naive users to embedded scripts.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
206
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
207 Comments
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
208
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
209 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
210