annotate GEMBASSY-1.0.3/doc/text/goligomersearch.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 goligomersearch
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 Searches oligomers in given 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 goligomersearch searches for the given oligomer in given sequence. Oligomer
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
9 can be specified using degenerate nucleotide alphabet, or by regular
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
10 expressions. Performance is optimized for fast searching.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
11 This method changes the returning value according to the given options.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
12
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
13 G-language SOAP service is provided by the
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
14 Institute for Advanced Biosciences, Keio University.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
15 The original web service is located at the following URL:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
16
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
17 http://www.g-language.org/wiki/soap
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
18
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
19 WSDL(RPC/Encoded) file is located at:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
20
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
21 http://soap.g-language.org/g-language.wsdl
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
22
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
23 Documentation on G-language Genome Analysis Environment methods are
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
24 provided at the Document Center
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
25
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
26 http://ws.g-language.org/gdoc/
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
27
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
28 Usage
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
29
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
30 Here is a sample session with goligomersearch
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
31
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
32 % goligomersearch refseqn:NC_000913 atgcatgc
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
33 Searches oligomers in given sequence
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
34 Program compseq output file [nc_000913.goligomersearch]:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
35
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
36 Go to the input files for this example
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
37 Go to the output files for this example
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
38
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
39 Command line arguments
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
40
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
41 Standard (Mandatory) qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
42 [-sequence] seqall Nucleotide sequence(s) filename and optional
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
43 format, or reference (input USA)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
44 [-oligomer] string Oligomer to search (Any string)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
45 [-outfile] outfile [*.goligomersearch] Program compseq output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
46 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 -return selection [position] 'position' to return list of
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
51 positions where oligomers are found, 'oligo'
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
52 to return list of oligomers found ordered
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
53 by positions, 'both' to return a hash with
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
54 positions as keys and oligomers as values,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
55 'distribution' to return four values about
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
56 the distribution of given oligomer
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
57 -[no]accid boolean [Y] Include to use sequence accession ID as
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
58 query
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
59
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
60 Associated qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
61
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
62 "-sequence" associated qualifiers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
63 -sbegin1 integer Start of each sequence to be used
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
64 -send1 integer End of each sequence to be used
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
65 -sreverse1 boolean Reverse (if DNA)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
66 -sask1 boolean Ask for begin/end/reverse
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
67 -snucleotide1 boolean Sequence is nucleotide
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
68 -sprotein1 boolean Sequence is protein
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
69 -slower1 boolean Make lower case
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
70 -supper1 boolean Make upper case
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
71 -scircular1 boolean Sequence is circular
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
72 -sformat1 string Input sequence format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
73 -iquery1 string Input query fields or ID list
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
74 -ioffset1 integer Input start position offset
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
75 -sdbname1 string Database name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
76 -sid1 string Entryname
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
77 -ufo1 string UFO features
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
78 -fformat1 string Features format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
79 -fopenfile1 string Features file name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
80
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
81 "-outfile" associated qualifiers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
82 -odirectory3 string Output directory
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
83
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
84 General qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
85 -auto boolean Turn off prompts
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
86 -stdout boolean Write first file to standard output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
87 -filter boolean Read first file from standard input, write
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
88 first file to standard output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
89 -options boolean Prompt for standard and additional values
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
90 -debug boolean Write debug output to program.dbg
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
91 -verbose boolean Report some/full command line options
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
92 -help boolean Report command line options and exit. More
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
93 information on associated and general
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
94 qualifiers can be found with -help -verbose
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
95 -warning boolean Report warnings
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
96 -error boolean Report errors
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
97 -fatal boolean Report fatal errors
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
98 -die boolean Report dying program messages
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
99 -version boolean Report version number and exit
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
100
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
101 Input file format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
102
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
103 The database definitions for following commands are available at
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
104 http://soap.g-language.org/kbws/embossrc
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
105
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
106 goligomersearch reads one or more nucleotide sequences.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
107
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
108 Output file format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
109
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
110 The output from goligomersearch is to a plain text file.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
111
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
112 File: nc_000913.goligomersearch
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
113
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
114 Sequence: NC_000913 Oligomer: atgcatgc Return: 147018,366819,653138,863326,1288615,1627117,2111200,2246695,2697278,2750962,2826906,2882353,2998362,3022134,3346029,3477018,3629113,3842819,3958304,3982183,4013480,4285578,4474663,4484501,4499080,4604562,4638391
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
115
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
116
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
117 Data files
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
118
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
119 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
120
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
121 Notes
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
122
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
123 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
124
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
125 References
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
126
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
127 Arakawa, K., Mori, K., Ikeda, K., Matsuzaki, T., Konayashi, Y., and
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
128 Tomita, M. (2003) G-language Genome Analysis Environment: A Workbench
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
129 for Nucleotide Sequence Data Mining, Bioinformatics, 19, 305-306.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
130
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
131 Arakawa, K. and Tomita, M. (2006) G-language System as a Platform for
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
132 large-scale analysis of high-throughput omics data, J. Pest Sci.,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
133 31, 7.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
134
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
135 Arakawa, K., Kido, N., Oshita, K., Tomita, M. (2010) G-language Genome
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
136 Analysis Environment with REST and SOAP Web Service Interfaces,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
137 Nucleic Acids Res., 38, W700-W705.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
138
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
139 Warnings
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
140
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
141 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
142
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
143 Diagnostic Error Messages
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
144
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
145 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
146
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
147 Exit status
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
148
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
149 It always exits with a status of 0.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
150
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
151 Known bugs
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 See also
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
156
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
157 gkmertable Create an image showing all k-mer abundance within a
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
158 sequence
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 gsignature Calculate oligonucleotide usage (genomic signature)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
162
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
163 Author(s)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
164
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
165 Hidetoshi Itaya (celery@g-language.org)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
166 Institute for Advanced Biosciences, Keio University
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
167 252-0882 Japan
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
168
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
169 Kazuharu Arakawa (gaou@sfc.keio.ac.jp)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
170 Institute for Advanced Biosciences, Keio University
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
171 252-0882 Japan
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
172
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
173 History
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
174
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
175 2012 - Written by Hidetoshi Itaya
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
176 2013 - Fixed by Hidetoshi Itaya
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
177
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
178 Target users
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
179
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
180 This program is intended to be used by everyone and everything, from
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
181 naive users to embedded scripts.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
182
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
183 Comments
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
184
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
185 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
186