annotate GEMBASSY-1.0.3/doc/text/gfop.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 gfop
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 Calculate the frequency of optimal codons (Fop)
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 gfop calculates the frequency of optimal codons (Fop).Fop is an index to
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
9 show the optimization level of synonymous codon usage choice. It is
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
10 basically a ratio of optimal codons against all codons used. The value
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
11 of Fop ranges from 0 (no optimal codons are used) and 1 (only optimal
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
12 codons are used).
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
13
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
14 G-language SOAP service is provided by the
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
15 Institute for Advanced Biosciences, Keio University.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
16 The original web service is located at the following URL:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
17
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
18 http://www.g-language.org/wiki/soap
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
19
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
20 WSDL(RPC/Encoded) file is located at:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
21
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
22 http://soap.g-language.org/g-language.wsdl
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
23
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
24 Documentation on G-language Genome Analysis Environment methods are
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
25 provided at the Document Center
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
26
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
27 http://ws.g-language.org/gdoc/
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
28
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
29 Usage
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
30
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
31 Here is a sample session with gfop
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
32
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
33 % gfop refseqn:NC_000913
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
34 Calculate the frequency of optimal codons (Fop)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
35 Codon usage output file [nc_000913.gfop]:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
36
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
37 Go to the input files for this example
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
38 Go to the output files for this example
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
39
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
40 Command line arguments
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
41
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
42 Standard (Mandatory) qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
43 [-sequence] seqall Nucleotide sequence(s) filename and optional
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
44 format, or reference (input USA)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
45 [-outfile] outfile [*.gfop] Codon usage output file
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
46
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
47 Additional (Optional) qualifiers: (none)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
48 Advanced (Unprompted) qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
49 -translate boolean [N] Include when translates using standard
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
50 codon table
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
51 -[no]accid boolean [Y] Include to use sequence accession ID as
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
52 query
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
53
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
54 Associated qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
55
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
56 "-sequence" associated qualifiers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
57 -sbegin1 integer Start of each sequence to be used
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
58 -send1 integer End of each sequence to be used
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
59 -sreverse1 boolean Reverse (if DNA)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
60 -sask1 boolean Ask for begin/end/reverse
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
61 -snucleotide1 boolean Sequence is nucleotide
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
62 -sprotein1 boolean Sequence is protein
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
63 -slower1 boolean Make lower case
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
64 -supper1 boolean Make upper case
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
65 -scircular1 boolean Sequence is circular
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
66 -sformat1 string Input sequence format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
67 -iquery1 string Input query fields or ID list
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
68 -ioffset1 integer Input start position offset
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
69 -sdbname1 string Database name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
70 -sid1 string Entryname
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
71 -ufo1 string UFO features
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
72 -fformat1 string Features format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
73 -fopenfile1 string Features file name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
74
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
75 "-outfile" associated qualifiers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
76 -odirectory2 string Output directory
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
77
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
78 General qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
79 -auto boolean Turn off prompts
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
80 -stdout boolean Write first file to standard output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
81 -filter boolean Read first file from standard input, write
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
82 first file to standard output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
83 -options boolean Prompt for standard and additional values
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
84 -debug boolean Write debug output to program.dbg
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
85 -verbose boolean Report some/full command line options
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
86 -help boolean Report command line options and exit. More
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
87 information on associated and general
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
88 qualifiers can be found with -help -verbose
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
89 -warning boolean Report warnings
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
90 -error boolean Report errors
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
91 -fatal boolean Report fatal errors
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
92 -die boolean Report dying program messages
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
93 -version boolean Report version number and exit
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
94
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
95 Input file format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
96
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
97 The database definitions for following commands are available at
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
98 http://soap.g-language.org/kbws/embossrc
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
99
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
100 gfop reads one or more nucleotide sequences.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
101
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
102 Output file format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
103
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
104 The output from gfop is to a plain text file.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
105
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
106 File: nc_000913.gfop
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
107
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
108 Sequence: NC_000913
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
109 Laa,Lc,fop,gene
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
110 20,5,0.4000,thrL
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
111 819,133,0.4361,thrA
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
112 309,46,0.4783,thrB
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
113 427,69,0.5217,thrC
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
114 97,7,0.2857,yaaX
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
115 257,56,0.4643,yaaA
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
116 475,96,0.3958,yaaJ
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
117 316,56,0.6964,talB
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
118
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
119 [Part of this file has been deleted for brevity]
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
120
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
121 169,27,0.2593,yjjX
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
122 214,23,0.5652,ytjC
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
123 288,49,0.4082,rob
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
124 156,23,0.3478,creA
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
125 228,26,0.3462,creB
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
126 473,69,0.3478,creC
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
127 449,70,0.3286,creD
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
128 237,46,0.6957,arcA
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
129 45,10,0.7000,yjjY
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
130 227,24,0.2500,yjtD
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
131
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
132
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
133 Data files
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
134
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
135 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
136
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
137 Notes
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
138
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
139 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
140
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
141 References
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
142
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
143 Ikemura, T. (1981) Correlation between the abundance of Escherichia coli
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
144 transfer RNAs and the occurrence of the respective codons in its protein
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
145 genes: a proposal for a synonymous codon choice that is optimal for the
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
146 E. coli translational system, J.Mol.Biol, 151:389-409.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
147
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
148 Ikemura (1985) Codon usage and tRNA content in unicellular and multicellular
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
149 organisms, Mol.Biol.Evol, 2(1):13-34.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
150
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
151 Arakawa, K., Mori, K., Ikeda, K., Matsuzaki, T., Konayashi, Y., and
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
152 Tomita, M. (2003) G-language Genome Analysis Environment: A Workbench
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
153 for Nucleotide Sequence Data Mining, Bioinformatics, 19, 305-306.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
154
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
155 Arakawa, K. and Tomita, M. (2006) G-language System as a Platform for
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
156 large-scale analysis of high-throughput omics data, J. Pest Sci.,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
157 31, 7.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
158
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
159 Arakawa, K., Kido, N., Oshita, K., Tomita, M. (2010) G-language Genome
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
160 Analysis Environment with REST and SOAP Web Service Interfaces,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
161 Nucleic Acids Res., 38, W700-W705.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
162
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
163 Warnings
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
164
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
165 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
166
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
167 Diagnostic Error Messages
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
168
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
169 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
170
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
171 Exit status
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
172
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
173 It always exits with a status of 0.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
174
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
175 Known bugs
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
176
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
177 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
178
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
179 See also
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
180
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
181 genc Calculate the effective number of codons (Nc)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
182 gew Calculate a measure of synonymous codon usage evenness (Ew)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
183 gscs Calculates the scaled chi-square
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
184 gwvalue Calculate the 'relative adaptiveness of each codon' (W)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
185
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
186 Author(s)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
187
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
188 Hidetoshi Itaya (celery@g-language.org)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
189 Institute for Advanced Biosciences, Keio University
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
190 252-0882 Japan
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
191
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
192 Kazuharu Arakawa (gaou@sfc.keio.ac.jp)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
193 Institute for Advanced Biosciences, Keio University
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
194 252-0882 Japan
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
195
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
196 History
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
197
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
198 2012 - Written by Hidetoshi Itaya
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
199 2013 - Fixed by Hidetoshi Itaya
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
200
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
201 Target users
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
202
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
203 This program is intended to be used by everyone and everything, from
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
204 naive users to embedded scripts.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
205
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
206 Comments
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
207
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
208 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
209