annotate GEMBASSY-1.0.3/doc/text/gcodoncompiler.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 gcodoncompiler
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 various kinds of amino acid and codon usage data
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 gcodoncompiler calculates various kinds of amino acid and codon usage data.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
9 The following values are calculable:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
10 A0: Absolute amino acid frequency
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
11 A1: Relative amino acid frequency
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
12 C0: Absolute codon frequency
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
13 C1: Relative codon frequency in a complete sequence
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
14 C2: Relative codon frequency in each amino acid
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
15 C3: Relative synonymous codon usage
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
16 C4: Relative adaptiveness
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
17 C5: Maximum or minor codon
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
18
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
19 For amino acids unpresent in a gene, C2-C3 does not calculate the values.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
20 By using R* in place, such values are hypothesized that alternative
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
21 synonymous codons are used with equal frequency.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
22
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
23 G-language SOAP service is provided by the
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
24 Institute for Advanced Biosciences, Keio University.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
25 The original web service is located at the following URL:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
26
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
27 http://www.g-language.org/wiki/soap
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
28
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
29 WSDL(RPC/Encoded) file is located at:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
30
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
31 http://soap.g-language.org/g-language.wsdl
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
32
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
33 Documentation on G-language Genome Analysis Environment methods are
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
34 provided at the Document Center
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
35
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
36 http://ws.g-language.org/gdoc/
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
37
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
38 Usage
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
39
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
40 Here is a sample session with gcodoncompiler
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
41
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
42 % gcodoncompiler refseqn:NC_000913
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
43 Calculate various kinds of amino acid and codon usage data
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
44 Codon usage output file [nc_000913.gcodoncompiler]:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
45
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
46 Go to the input files for this example
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
47 Go to the output files for this example
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
48
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
49 Command line arguments
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
50
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
51 Standard (Mandatory) qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
52 [-sequence] seqall Nucleotide sequence(s) filename and optional
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
53 format, or reference (input USA)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
54 [-outfile] outfile [*.gcodoncompiler] Codon usage output file
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
55
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
56 Additional (Optional) qualifiers: (none)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
57 Advanced (Unprompted) qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
58 -translate boolean [N] Include to translate using standard
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
59 codon table
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
60 -startcodon boolean [N] Include to include start codon
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
61 -stopcodon boolean [N] Include to include stop codon
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
62 -delkey string [[^ACDEFGHIKLMNPQRSTVWYacgtU]] Regular
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
63 expression to delete key (i.e. amino acids
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
64 and nucleotides) (Any string)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
65 -data menu [R0] Kinds of codon usage data. R*
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
66 hypothesizes amino acids which are not
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
67 present in the gene (Values: A0 (Absolute
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
68 amino acid frequency ('AA')); A1 (Relative
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
69 amino acid frequency ('RAAU')); C0 (Absolute
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
70 codon frequency ('AF')); C1 (Relative codon
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
71 frequency in a complete sequence); C2
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
72 (Relative codon frequency in each amino acid
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
73 ('RF')); C3 (Relative synonymous codon
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
74 usage ('RSCU')); C4 (Relative adaptiveness);
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
75 i.e., ratio to maximum of minor codon ('W')
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
76 C5 (Maximum (1) or minor (0) codon); R0
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
77 (Absolute codon frequency ('AF')); R1
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
78 (Relative codon frequency in a complete
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
79 sequence); R2 (Relative codon frequency in
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
80 each amino acid ('RF')); R3 (Relative
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
81 synonymous codon usage ('RSCU')); R4
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
82 (Relative adaptiveness); i.e., ratio to
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
83 maximum of minor codon ('W') R5 (Maximum (1)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
84 or minor (0) codon))
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
85 -[no]accid boolean [Y] Include to use sequence accession ID as
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
86 query
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
87
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
88 Associated qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
89
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
90 "-sequence" associated qualifiers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
91 -sbegin1 integer Start of each sequence to be used
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
92 -send1 integer End of each sequence to be used
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
93 -sreverse1 boolean Reverse (if DNA)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
94 -sask1 boolean Ask for begin/end/reverse
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
95 -snucleotide1 boolean Sequence is nucleotide
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
96 -sprotein1 boolean Sequence is protein
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
97 -slower1 boolean Make lower case
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
98 -supper1 boolean Make upper case
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
99 -scircular1 boolean Sequence is circular
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
100 -sformat1 string Input sequence format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
101 -iquery1 string Input query fields or ID list
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
102 -ioffset1 integer Input start position offset
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
103 -sdbname1 string Database name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
104 -sid1 string Entryname
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
105 -ufo1 string UFO features
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
106 -fformat1 string Features format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
107 -fopenfile1 string Features file name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
108
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
109 "-outfile" associated qualifiers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
110 -odirectory2 string Output directory
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
111
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
112 General qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
113 -auto boolean Turn off prompts
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
114 -stdout boolean Write first file to standard output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
115 -filter boolean Read first file from standard input, write
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
116 first file to standard output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
117 -options boolean Prompt for standard and additional values
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
118 -debug boolean Write debug output to program.dbg
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
119 -verbose boolean Report some/full command line options
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
120 -help boolean Report command line options and exit. More
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
121 information on associated and general
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
122 qualifiers can be found with -help -verbose
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
123 -warning boolean Report warnings
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
124 -error boolean Report errors
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
125 -fatal boolean Report fatal errors
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
126 -die boolean Report dying program messages
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
127 -version boolean Report version number and exit
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
128
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
129 Input file format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
130
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
131 The database definitions for following commands are available at
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
132 http://soap.g-language.org/kbws/embossrc
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
133
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
134 gcodoncompiler reads one or more nucleotide sequences.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
135
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
136 Output file format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
137
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
138 The output from gcodoncompiler is to a plain text file.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
139
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
140 File: nc_000913.gcodoncompiler
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
141
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
142 Sequence: NC_000913
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
143 Agca,Agcc,Agcg,Agct,Ctgc,Ctgt,Dgac,Dgat,Egaa,Egag,Fttc,Fttt,Ggga,Gggc,Gggg,Gggt,Hcac,Hcat,Iata,Iatc,Iatt,Kaaa,Kaag,Lcta,Lctc,Lctg,Lctt,Ltta,Lttg,Matg,Naac,Naat,Pcca,Pccc,Pccg,Pcct,Qcaa,Qcag,Raga,Ragg,Rcga,Rcgc,Rcgg,Rcgt,Sagc,Sagt,Stca,Stcc,Stcg,Stct,Taca,Tacc,Tacg,Tact,Utga,Vgta,Vgtc,Vgtg,Vgtt,Wtgg,Ytac,Ytat,locus_tag
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
144 26551,33911,44924,20010,8486,6707,25234,42161,52362,23474,21841,29334,10226,39395,14472,32678,12830,16952,5356,33359,40221,44272,13398,5079,14709,70441,14410,18097,17936,32971,28329,22786,11063,7142,30994,9130,20216,38169,2495,1366,4529,29308,6991,27864,21132,11323,9159,11332,11759,10992,8979,31001,18989,11581,3,14337,20240,34499,24056,20071,16088,21069,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
145
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
146
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
147 Data files
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
148
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
149 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
150
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
151 Notes
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
152
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
153 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
154
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
155 References
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
156
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
157 Arakawa, K., Mori, K., Ikeda, K., Matsuzaki, T., Konayashi, Y., and
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
158 Tomita, M. (2003) G-language Genome Analysis Environment: A Workbench
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
159 for Nucleotide Sequence Data Mining, Bioinformatics, 19, 305-306.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
160
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
161 Arakawa, K. and Tomita, M. (2006) G-language System as a Platform for
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
162 large-scale analysis of high-throughput omics data, J. Pest Sci.,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
163 31, 7.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
164
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
165 Arakawa, K., Kido, N., Oshita, K., Tomita, M. (2010) G-language Genome
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
166 Analysis Environment with REST and SOAP Web Service Interfaces,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
167 Nucleic Acids Res., 38, W700-W705.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
168
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
169 Warnings
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
170
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
171 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
172
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
173 Diagnostic Error Messages
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
174
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
175 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
176
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
177 Exit status
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
178
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
179 It always exits with a status of 0.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
180
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
181 Known bugs
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
182
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
183 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
184
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
185 See also
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
186
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
187 gaminoinfo Prints out basic amino acid sequence statistics
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
188 gaaui Calculates various indece of amino acid usage
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
189
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
190 Author(s)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
191
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
192 Hidetoshi Itaya (celery@g-language.org)
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 Kazuharu Arakawa (gaou@sfc.keio.ac.jp)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
197 Institute for Advanced Biosciences, Keio University
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
198 252-0882 Japan
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
199
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
200 History
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
201
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
202 2012 - Written by Hidetoshi Itaya
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
203 2013 - Fixed by Hidetoshi Itaya
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
204
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
205 Target users
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
206
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
207 This program is intended to be used by everyone and everything, from
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
208 naive users to embedded scripts.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
209
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
210 Comments
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
211
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
212 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
213