annotate GEMBASSY-1.0.3/doc/text/ggcsi.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 ggcsi
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 GC Skew Index: an index for strand-specific mutational bias
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 ggcsi calculates the GC Skew Index (GCSI) of the given circular bacterial
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
9 genome. GCSI quantifies the degree of GC Skew. In other words, this index
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
10 represents the degree of strand-specific mutational bias in bacterial
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
11 genomes, caused by replicational selection.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
12 GCSI is calculated by the following formula:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
13
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
14 GCSI = sqrt((SA/6000) * (dist/600))
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
15
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
16 where SA is the spectral amplitude of Fourier power spectrum at 1Hz,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
17 and dist is the normalized Euclidean distance between the vertices of
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
18 cumulative GC skew.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
19
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
20 GCSI ranges from 0 (no observable skew) to 1 (strong skew), and Archaeal
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
21 genomes that have multiple replication origins and therefore have no
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
22 observable skew mostly have GCSI below 0.05. Escherichia coli genome has
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
23 values around 0.10.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
24
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
25 Version 1 of GCSI required fixed number of windows (4096), but the new GCSI
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
26 version 2 (also known as generalized GCSI: gGCSI) is invariant of the number
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
27 of windows. GCSI version 1 is calculated as an arithmetic mean (as opposed
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
28 to the geometric mean of gGCSI) of SR (spectral ratio, the signal-to-noise
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
29 ratio of 1Hz power spectrum) and dist.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
30
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
31 G-language SOAP service is provided by the
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
32 Institute for Advanced Biosciences, Keio University.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
33 The original web service is located at the following URL:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
34
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
35 http://www.g-language.org/wiki/soap
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
36
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
37 WSDL(RPC/Encoded) file is located at:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
38
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
39 http://soap.g-language.org/g-language.wsdl
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
40
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
41 Documentation on G-language Genome Analysis Environment methods are
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
42 provided at the Document Center
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
43
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
44 http://ws.g-language.org/gdoc/
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
45
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
46 Usage
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
47
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
48 Here is a sample session with ggcsi
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
49
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
50 % ggcsi refseqn:NC_000913
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
51 GC Skew Index: an index for strand-specific mutational bias
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
52 Program compseq output file [nc_000913.ggcsi]:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
53
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
54 Go to the input files for this example
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
55 Go to the output files for this example
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
56
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
57 Command line arguments
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
58
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
59 Standard (Mandatory) qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
60 [-sequence] seqall Nucleotide sequence(s) filename and optional
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
61 format, or reference (input USA)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
62 [-outfile] outfile [*.ggcsi] Program compseq output file
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
63
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
64 Additional (Optional) qualifiers: (none)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
65 Advanced (Unprompted) qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
66 -gcsi selection [2] GCSI version to use
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
67 -window integer [4096] Number of windows. Must be a power of
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
68 2 (Any integer value)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
69 -purine boolean [N] Use purine skew for calculation
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
70 -keto boolean [N] Use keto skew for calculation
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
71 -at boolean [N] Use AT skew for calculation
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
72 -pval boolean [N] Calculate p-value when GCSI version 2 is
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
73 selected
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
74 -[no]accid boolean [Y] Include to use sequence accession ID as
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
75 query
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
76
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
77 Associated qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
78
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
79 "-sequence" associated qualifiers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
80 -sbegin1 integer Start of each sequence to be used
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
81 -send1 integer End of each sequence to be used
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
82 -sreverse1 boolean Reverse (if DNA)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
83 -sask1 boolean Ask for begin/end/reverse
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
84 -snucleotide1 boolean Sequence is nucleotide
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
85 -sprotein1 boolean Sequence is protein
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
86 -slower1 boolean Make lower case
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
87 -supper1 boolean Make upper case
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
88 -scircular1 boolean Sequence is circular
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
89 -sformat1 string Input sequence format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
90 -iquery1 string Input query fields or ID list
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
91 -ioffset1 integer Input start position offset
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
92 -sdbname1 string Database name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
93 -sid1 string Entryname
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
94 -ufo1 string UFO features
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
95 -fformat1 string Features format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
96 -fopenfile1 string Features file name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
97
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
98 "-outfile" associated qualifiers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
99 -odirectory2 string Output directory
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
100
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
101 General qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
102 -auto boolean Turn off prompts
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
103 -stdout boolean Write first file to standard output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
104 -filter boolean Read first file from standard input, write
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
105 first file to standard output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
106 -options boolean Prompt for standard and additional values
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
107 -debug boolean Write debug output to program.dbg
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
108 -verbose boolean Report some/full command line options
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
109 -help boolean Report command line options and exit. More
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
110 information on associated and general
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
111 qualifiers can be found with -help -verbose
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
112 -warning boolean Report warnings
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
113 -error boolean Report errors
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
114 -fatal boolean Report fatal errors
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
115 -die boolean Report dying program messages
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
116 -version boolean Report version number and exit
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
117
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
118 Input file format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
119
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
120 The database definitions for following commands are available at
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
121 http://soap.g-language.org/kbws/embossrc
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
122
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
123 ggcsi reads one or more nucleotide sequences.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
124
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
125 Output file format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
126
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
127 The output from ggcsi is to a plain text file.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
128
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
129 File: nc_000913.ggcsi
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
130
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
131 Sequence: NC_000913 GCSI: 0.0966615833014818 SA: 487.218569030757 DIST: 69.037726
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
132
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
133
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
134 Data files
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
135
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
136 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
137
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
138 Notes
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
139
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
140 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
141
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
142 References
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
143
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
144 Arakawa, K., Mori, K., Ikeda, K., Matsuzaki, T., Konayashi, Y., and
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
145 Tomita, M. (2003) G-language Genome Analysis Environment: A Workbench
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
146 for Nucleotide Sequence Data Mining, Bioinformatics, 19, 305-306.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
147
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
148 Arakawa, K. and Tomita, M. (2006) G-language System as a Platform for
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
149 large-scale analysis of high-throughput omics data, J. Pest Sci.,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
150 31, 7.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
151
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
152 Arakawa, K., Kido, N., Oshita, K., Tomita, M. (2010) G-language Genome
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
153 Analysis Environment with REST and SOAP Web Service Interfaces,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
154 Nucleic Acids Res., 38, W700-W705.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
155
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
156 Warnings
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
157
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
158 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
159
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
160 Diagnostic Error Messages
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
161
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
162 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
163
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
164 Exit status
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
165
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
166 It always exits with a status of 0.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
167
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
168 Known bugs
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 See also
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
173
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
174 gb1 Calculate strand bias of bacterial genome using B1 index
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
175 gb2 Calculate strand bias of bacterial genome using B2 index
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
176 gdeltagcskew Calculate strand bias of bacterial genome using delta GC skew
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
177 index
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
178 gldabias Calculate strand bias of bacterial genome using linear
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
179 discriminant analysis (LDA)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
180
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
181 Author(s)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
182
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
183 Hidetoshi Itaya (celery@g-language.org)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
184 Institute for Advanced Biosciences, Keio University
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
185 252-0882 Japan
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
186
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
187 Kazuharu Arakawa (gaou@sfc.keio.ac.jp)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
188 Institute for Advanced Biosciences, Keio University
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
189 252-0882 Japan
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
190
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
191 History
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
192
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
193 2012 - Written by Hidetoshi Itaya
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
194 2013 - Fixed by Hidetoshi Itaya
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
195
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
196 Target users
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
197
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
198 This program is intended to be used by everyone and everything, from
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
199 naive users to embedded scripts.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
200
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
201 Comments
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
202
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
203 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
204