annotate GEMBASSY-1.0.3/doc/text/gkmertable.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 gkmertable
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 Create an image showing all k-mer abundance within a sequence
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 gkmertable creates an image showing the abundance of all k-mers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
9 (oligonucleotides of length k) in a given sequence. For example, for
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
10 tetramers (k=4), resulting image is composed of 4^4 = 256 boxes, each
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
11 representing an oligomer. Oligomer name and abundance is written within
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
12 these boxes, and abundance is also visualized with the box color, from
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
13 white (none) to black (highly frequent).
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
14
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
15 This k-mer table is alternatively known as the FCGR (frequency matrices
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
16 extracted from Chaos Game Representation).
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
17 Position of the oligomers can be recursively located as follows:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
18 For each letter in an oligomer, a box is subdivided into four quadrants,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
19 where A is upper left, T is lower right, G is upper right, and C is lower
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
20 left.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
21
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
22 Therefore, oligomer ATGC is in the
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
23 A = upper left quadrant
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
24 T = lower right within the above quadrant
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
25 G = upper right within the above quadrant
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
26 C = lower left within the above quadrant
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
27 More detailed documentation is available at
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
28 http://www.g-language.org/wiki/cgr
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
29
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
30 G-language SOAP service is provided by the
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
31 Institute for Advanced Biosciences, Keio University.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
32 The original web service is located at the following URL:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
33
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
34 http://www.g-language.org/wiki/soap
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
35
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
36 WSDL(RPC/Encoded) file is located at:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
37
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
38 http://soap.g-language.org/g-language.wsdl
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
39
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
40 Documentation on G-language Genome Analysis Environment methods are
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
41 provided at the Document Center
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
42
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
43 http://ws.g-language.org/gdoc/
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
44
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
45 Usage
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
46
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
47 Here is a sample session with gkmertable
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
48
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
49 % gkmertable refseqn:NC_000913
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
50 Create an image showing all k-mer abundance within a sequence
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
51 Created gkmertable.1.png
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
52
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
53 Go to the input files for this example
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
54 Go to the output files for this example
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
55
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
56 Command line arguments
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
57
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
58 Standard (Mandatory) qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
59 [-sequence] seqall Nucleotide sequence(s) filename and optional
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
60 format, or reference (input USA)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
61
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
62 Additional (Optional) qualifiers: (none)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
63 Advanced (Unprompted) qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
64 -format string [png] Output file format. Dependent on
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
65 'convert' command (Any string)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
66 -k integer [6] Length of oligomer (Any integer value)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
67 -goutfile string [gkmertable] Output file for non interactive
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
68 displays (Any string)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
69
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
70 Associated qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
71
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
72 "-sequence" associated qualifiers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
73 -sbegin1 integer Start of each sequence to be used
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
74 -send1 integer End of each sequence to be used
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
75 -sreverse1 boolean Reverse (if DNA)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
76 -sask1 boolean Ask for begin/end/reverse
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
77 -snucleotide1 boolean Sequence is nucleotide
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
78 -sprotein1 boolean Sequence is protein
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
79 -slower1 boolean Make lower case
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
80 -supper1 boolean Make upper case
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
81 -scircular1 boolean Sequence is circular
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
82 -sformat1 string Input sequence format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
83 -iquery1 string Input query fields or ID list
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
84 -ioffset1 integer Input start position offset
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
85 -sdbname1 string Database name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
86 -sid1 string Entryname
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
87 -ufo1 string UFO features
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
88 -fformat1 string Features format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
89 -fopenfile1 string Features file name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
90
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
91 General qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
92 -auto boolean Turn off prompts
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
93 -stdout boolean Write first file to standard output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
94 -filter boolean Read first file from standard input, write
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
95 first file to standard output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
96 -options boolean Prompt for standard and additional values
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
97 -debug boolean Write debug output to program.dbg
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
98 -verbose boolean Report some/full command line options
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
99 -help boolean Report command line options and exit. More
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
100 information on associated and general
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
101 qualifiers can be found with -help -verbose
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
102 -warning boolean Report warnings
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
103 -error boolean Report errors
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
104 -fatal boolean Report fatal errors
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
105 -die boolean Report dying program messages
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
106 -version boolean Report version number and exit
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
107
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
108 Input file format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
109
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
110 The database definitions for following commands are available at
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
111 http://soap.g-language.org/kbws/embossrc
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
112
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
113 gkmertable reads one or more nucleotide sequences.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
114
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
115 Output file format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
116
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
117 The output from gkmertable is to an image file.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
118
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
119 Data files
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
120
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
121 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
122
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
123 Notes
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
124
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
125 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
126
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
127 References
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
128
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
129 Arakawa, K., Mori, K., Ikeda, K., Matsuzaki, T., Konayashi, Y., and
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
130 Tomita, M. (2003) G-language Genome Analysis Environment: A Workbench
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
131 for Nucleotide Sequence Data Mining, Bioinformatics, 19, 305-306.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
132
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
133 Arakawa, K. and Tomita, M. (2006) G-language System as a Platform for
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
134 large-scale analysis of high-throughput omics data, J. Pest Sci.,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
135 31, 7.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
136
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
137 Arakawa, K., Kido, N., Oshita, K., Tomita, M. (2010) G-language Genome
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
138 Analysis Environment with REST and SOAP Web Service Interfaces,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
139 Nucleic Acids Res., 38, W700-W705.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
140
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
141 Warnings
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 Diagnostic Error Messages
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
146
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
147 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
148
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
149 Exit status
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
150
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
151 It always exits with a status of 0.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
152
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
153 Known bugs
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
154
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
155 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
156
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
157 See also
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
158
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
159 gnucleotideperiodicity Checks the periodicity of certain oligonucleotides
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
160 goligomercounter Counts the number of given oligomers in a sequence
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
161 goligomersearch Searches oligomers in given sequence
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
162 gsignature Calculate oligonucleotide usage (genomic signature)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
163
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
164 Author(s)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
165
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
166 Hidetoshi Itaya (celery@g-language.org)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
167 Institute for Advanced Biosciences, Keio University
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
168 252-0882 Japan
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
169
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
170 Kazuharu Arakawa (gaou@sfc.keio.ac.jp)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
171 Institute for Advanced Biosciences, Keio University
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
172 252-0882 Japan
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
173
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
174 History
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
175
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
176 2012 - Written by Hidetoshi Itaya
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
177 2013 - Fixed by Hidetoshi Itaya
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
178
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
179 Target users
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
180
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
181 This program is intended to be used by everyone and everything, from
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
182 naive users to embedded scripts.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
183
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
184 Comments
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
185
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
186 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
187