annotate GEMBASSY-1.0.3/doc/text/genc.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 genc
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 effective number of codons (Nc)
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 genc calculates the effective number of codons (ENC|Nc). ENC is a measure
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
9 for species-independent codon usage bias. Some measures including CAI are
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
10 species-dependent as optimal codons differ. ENC assigns a gene a number
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
11 between 20 to 61 where 20 indicates that one codon is used for each amino
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
12 acid and 61 indicates that each codon is used equally throughout the
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
13 protein sequence.
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 genc
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
33
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
34 % genc refseqn:NC_000913
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
35 Calculate the effective number of codons (Nc)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
36 Codon usage output file [nc_000913.genc]:
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 [*.genc] 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 translates 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 (i.e. amino acids
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
54 and nucleotides) (Any string)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
55 -[no]accid boolean [Y] Include to use sequence accession ID as
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
56 query
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
57
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
58 Associated qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
59
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
60 "-sequence" associated qualifiers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
61 -sbegin1 integer Start of each sequence to be used
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
62 -send1 integer End of each sequence to be used
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
63 -sreverse1 boolean Reverse (if DNA)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
64 -sask1 boolean Ask for begin/end/reverse
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
65 -snucleotide1 boolean Sequence is nucleotide
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
66 -sprotein1 boolean Sequence is protein
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
67 -slower1 boolean Make lower case
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
68 -supper1 boolean Make upper case
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
69 -scircular1 boolean Sequence is circular
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
70 -sformat1 string Input sequence format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
71 -iquery1 string Input query fields or ID list
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
72 -ioffset1 integer Input start position offset
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
73 -sdbname1 string Database name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
74 -sid1 string Entryname
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
75 -ufo1 string UFO features
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
76 -fformat1 string Features format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
77 -fopenfile1 string Features file name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
78
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
79 "-outfile" associated qualifiers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
80 -odirectory2 string Output directory
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
81
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
82 General qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
83 -auto boolean Turn off prompts
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
84 -stdout boolean Write first file to standard output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
85 -filter boolean Read first file from standard input, write
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
86 first file to standard output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
87 -options boolean Prompt for standard and additional values
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
88 -debug boolean Write debug output to program.dbg
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
89 -verbose boolean Report some/full command line options
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
90 -help boolean Report command line options and exit. More
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
91 information on associated and general
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
92 qualifiers can be found with -help -verbose
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
93 -warning boolean Report warnings
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
94 -error boolean Report errors
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
95 -fatal boolean Report fatal errors
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
96 -die boolean Report dying program messages
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
97 -version boolean Report version number and exit
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
98
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
99 Input file format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
100
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
101 The database definitions for following commands are available at
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
102 http://soap.g-language.org/kbws/embossrc
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
103
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
104 genc reads one or more nucleotide sequences.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
105
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
106 Output file format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
107
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
108 The output from genc is to a plain text file.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
109
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
110 File: nc_000913.genc
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
111
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
112 Sequence: NC_000913
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
113 enc,gene
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
114 ,thrL
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
115 48.41,thrA
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
116 54.13,thrB
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
117 46.18,thrC
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
118 51.65,yaaX
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
119 45.71,yaaA
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
120 48.54,yaaJ
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
121 36.83,talB
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
122
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
123 [Part of this file has been deleted for brevity]
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
124
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
125 51.43,yjjX
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
126 46.61,ytjC
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
127 49.83,rob
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
128 47.74,creA
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
129 50.63,creB
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
130 51.39,creC
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
131 48.42,creD
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
132 41.53,arcA
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
133 61,yjjY
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
134 53.63,yjtD
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
135
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
136
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
137 Data files
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 Notes
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
142
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
143 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
144
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
145 References
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
146
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
147 Comeron JM, Aguade M. (1998) An evaluation of measures of synonymous codon
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
148 usage bias, J Mol Evol, 47(3):268-74.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
149
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
150 Wright F. (1990) The 'effective number of codons' used in a gene, Gene,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
151 87:23-29.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
152
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
153 Arakawa, K., Mori, K., Ikeda, K., Matsuzaki, T., Konayashi, Y., and
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
154 Tomita, M. (2003) G-language Genome Analysis Environment: A Workbench
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
155 for Nucleotide Sequence Data Mining, Bioinformatics, 19, 305-306.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
156
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
157 Arakawa, K. and Tomita, M. (2006) G-language System as a Platform for
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
158 large-scale analysis of high-throughput omics data, J. Pest Sci.,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
159 31, 7.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
160
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
161 Arakawa, K., Kido, N., Oshita, K., Tomita, M. (2010) G-language Genome
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
162 Analysis Environment with REST and SOAP Web Service Interfaces,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
163 Nucleic Acids Res., 38, W700-W705.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
164
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
165 Warnings
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
166
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
167 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
168
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
169 Diagnostic Error Messages
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 Exit status
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
174
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
175 It always exits with a status of 0.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
176
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
177 Known bugs
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
178
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
179 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
180
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
181 See also
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
182
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
183 gew Calculate a measure of synonymous codon usage evenness (Ew)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
184 gfop Calculate the frequency of optimal codons (Fop)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
185 gscs Calculates the scaled chi-square
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
186 gwvalue Calculate the 'relative adaptiveness of each codon' (W)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
187
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
188 Author(s)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
189
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
190 Hidetoshi Itaya (celery@g-language.org)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
191 Institute for Advanced Biosciences, Keio University
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
192 252-0882 Japan
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
193
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
194 Kazuharu Arakawa (gaou@sfc.keio.ac.jp)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
195 Institute for Advanced Biosciences, Keio University
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
196 252-0882 Japan
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
197
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
198 History
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
199
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
200 2012 - Written by Hidetoshi Itaya
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
201 2013 - Fixed by Hidetoshi Itaya
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
202
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
203 Target users
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
204
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
205 This program is intended to be used by everyone and everything, from
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
206 naive users to embedded scripts.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
207
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
208 Comments
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