annotate GEMBASSY-1.0.3/doc/text/greporiter.txt @ 1:84a17b3fad1f draft

Uploaded
author ktnyt
date Fri, 26 Jun 2015 05:20:29 -0400
parents 8300eb051bea
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
1 greporiter
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 Get the positions of replication origin and terminus
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 greporiter returns the positions of replication origin and terminus
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
9 in bacterial genomes by several means.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
10
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
11 1. Use of databases
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
12 By default, grep_ori_ter tries to retrieve the position of replication
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
13 origin in DoriC Gao and Zhang (2007) database, and the position of
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
14 replication terminus from the supplemental data provided in
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
15 Kono et al. (2011).
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
16 If the position of origin cannot be found in the database, but "rep_origin"
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
17 feature is available, center position within this feature is used for
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
18 origin.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
19
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
20 2. Oriloc
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
21 Using -orilocoption, you can predict the replication origin and
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
22 terminus using the popular Oriloc program developed by Lobry et al.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
23 available as part of the SeqinR package Frank and Lobry (2000).
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
24
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
25 3. Use GC skew shift-point
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
26 If the positions of origin or terminus cannot be found in the databases,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
27 grep_ori_ter automatically calls find_ori_ter() method to predict the
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
28 positions using GC skew shift-points at one-base-pair resolution.
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 greporiter
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
48
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
49 % greporiter refseqn:NC_000913
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
50 Get the positions of replication origin and terminus
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
51 Output file [nc_000913.greporiter]:
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 [-outfile] outfile [*.greporiter] Output file name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
62
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
63 Additional (Optional) qualifiers: (none)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
64 Advanced (Unprompted) qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
65 -oriloc boolean [N] Include Oriloc for prediction
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
66 -gcskew boolean [N] Include to use GC skew shift-point for
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
67 prediction
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
68 -difthreshold integer [0] Distance between the GC skew shift point
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
69 and predicted dif site expressed as the
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
70 precentage of genome size, used as a
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
71 threshold to retrieve dif sequence from the
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
72 database (Any integer value)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
73 -dbonly boolean [N] Include to only use values available in
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
74 databases and to suppress prediction
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
75 -[no]accid boolean [Y] Include to use sequence accession ID as
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
76 query
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
77
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
78 Associated qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
79
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
80 "-sequence" associated qualifiers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
81 -sbegin1 integer Start of each sequence to be used
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
82 -send1 integer End of each sequence to be used
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
83 -sreverse1 boolean Reverse (if DNA)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
84 -sask1 boolean Ask for begin/end/reverse
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
85 -snucleotide1 boolean Sequence is nucleotide
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
86 -sprotein1 boolean Sequence is protein
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
87 -slower1 boolean Make lower case
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
88 -supper1 boolean Make upper case
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
89 -scircular1 boolean Sequence is circular
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
90 -sformat1 string Input sequence format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
91 -iquery1 string Input query fields or ID list
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
92 -ioffset1 integer Input start position offset
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
93 -sdbname1 string Database name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
94 -sid1 string Entryname
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
95 -ufo1 string UFO features
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
96 -fformat1 string Features format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
97 -fopenfile1 string Features file name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
98
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
99 "-outfile" associated qualifiers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
100 -odirectory2 string Output directory
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
101
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
102 General qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
103 -auto boolean Turn off prompts
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
104 -stdout boolean Write first file to standard output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
105 -filter boolean Read first file from standard input, write
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
106 first file to standard output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
107 -options boolean Prompt for standard and additional values
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
108 -debug boolean Write debug output to program.dbg
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
109 -verbose boolean Report some/full command line options
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
110 -help boolean Report command line options and exit. More
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
111 information on associated and general
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
112 qualifiers can be found with -help -verbose
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
113 -warning boolean Report warnings
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
114 -error boolean Report errors
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
115 -fatal boolean Report fatal errors
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
116 -die boolean Report dying program messages
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
117 -version boolean Report version number and exit
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
118
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
119 Input file format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
120
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
121 The database definitions for following commands are available at
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
122 http://soap.g-language.org/kbws/embossrc
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
123
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
124 greporiter reads one or more nucleotide sequences.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
125
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
126 Output file format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
127
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
128 The output from greporiter is to a plain text file.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
129
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
130 File: nc_000913.greporiter
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
131
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
132 Sequence: NC_000913 Origin: 3923881 Terminus: 1550412
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
133
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
134
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
135 Data files
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
136
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
137 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
138
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
139 Notes
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 References
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
144
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
145 Gao F and Zhang CT (2007) DoriC: a database of oriC regions in bacterial
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
146 genomes, Bioinformatics, 23(14):1866-1867
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
147
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
148 Kono N et al. (2011) Comprehensive prediction of chromosome dimer resolution
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
149 sites in bacterial genomes, BMC Genomics, 12(1):19
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
150
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
151 Frank AC and Lobry JR (2000) "Oriloc: prediction of replication boundaries
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
152 in unannotated bacterial chromosomes", Bioinformatics, 16(6):560-561
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
153
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
154 Arakawa, K., Mori, K., Ikeda, K., Matsuzaki, T., Konayashi, Y., and
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
155 Tomita, M. (2003) G-language Genome Analysis Environment: A Workbench
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
156 for Nucleotide Sequence Data Mining, Bioinformatics, 19, 305-306.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
157
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
158 Arakawa, K. and Tomita, M. (2006) G-language System as a Platform for
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
159 large-scale analysis of high-throughput omics data, J. Pest Sci.,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
160 31, 7.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
161
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
162 Arakawa, K., Kido, N., Oshita, K., Tomita, M. (2010) G-language Genome
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
163 Analysis Environment with REST and SOAP Web Service Interfaces,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
164 Nucleic Acids Res., 38, W700-W705.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
165
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
166 Warnings
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
167
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
168 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
169
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
170 Diagnostic Error Messages
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
171
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
172 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
173
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
174 Exit status
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
175
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
176 It always exits with a status of 0.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
177
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
178 Known bugs
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
179
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
180 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
181
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
182 See also
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
183
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
184 gfindoriter Predicts the replication origin and terminus in bacterial
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
185 genomes
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
186
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
187 Author(s)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
188
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
189 Hidetoshi Itaya (celery@g-language.org)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
190 Institute for Advanced Biosciences, Keio University
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
191 252-0882 Japan
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
192
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
193 Kazuharu Arakawa (gaou@sfc.keio.ac.jp)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
194 Institute for Advanced Biosciences, Keio University
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
195 252-0882 Japan
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
196
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
197 History
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
198
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
199 2012 - Written by Hidetoshi Itaya
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
200 2013 - Fixed by Hidetoshi Itaya
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
201
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
202 Target users
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
203
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
204 This program is intended to be used by everyone and everything, from
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
205 naive users to embedded scripts.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
206
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
207 Comments
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
208
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
209 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
210