annotate GEMBASSY-1.0.3/doc/text/gdistincc.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 gdistincc
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 Calculates the distance between two loci in circular chromosomes
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 gdistincc calculates the distance between two loci in circular
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
9 chromosomes. It is mostly useful to calculate the distance from the
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
10 replication origin.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
11
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
12 G-language SOAP service is provided by the
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
13 Institute for Advanced Biosciences, Keio University.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
14 The original web service is located at the following URL:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
15
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
16 http://www.g-language.org/wiki/soap
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
17
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
18 WSDL(RPC/Encoded) file is located at:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
19
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
20 http://soap.g-language.org/g-language.wsdl
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
21
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
22 Documentation on G-language Genome Analysis Environment methods are
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
23 provided at the Document Center
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
24
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
25 http://ws.g-language.org/gdoc/
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
26
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
27 Usage
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
28
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
29 Here is a sample session with gdistincc
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
30
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
31 % gdistincc refseqn:NC_000913 1234
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
32 Calculates the distance between two loci in circular chromosomes
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
33 Output file [nc_000913.gdistincc]:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
34
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
35 Go to the input files for this example
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
36 Go to the output files for this example
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
37
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
38 Command line arguments
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
39
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
40 Standard (Mandatory) qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
41 [-sequence] seqall Nucleotide sequence(s) filename and optional
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
42 format, or reference (input USA)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
43 [-first] integer [0] Position to find the distance (Any
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
44 integer value)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
45 [-outfile] outfile [*.gdistincc] Output file name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
46
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
47 Additional (Optional) qualifiers: (none)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
48 Advanced (Unprompted) qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
49 -second integer [-1] If the second position is negative,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
50 position of replication origin is used (Any
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
51 integer value)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
52 -[no]accid boolean [Y] Include to use sequence accession ID as
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
53 query
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
54
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
55 Associated qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
56
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
57 "-sequence" associated qualifiers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
58 -sbegin1 integer Start of each sequence to be used
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
59 -send1 integer End of each sequence to be used
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
60 -sreverse1 boolean Reverse (if DNA)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
61 -sask1 boolean Ask for begin/end/reverse
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
62 -snucleotide1 boolean Sequence is nucleotide
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
63 -sprotein1 boolean Sequence is protein
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
64 -slower1 boolean Make lower case
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
65 -supper1 boolean Make upper case
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
66 -scircular1 boolean Sequence is circular
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
67 -sformat1 string Input sequence format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
68 -iquery1 string Input query fields or ID list
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
69 -ioffset1 integer Input start position offset
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
70 -sdbname1 string Database name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
71 -sid1 string Entryname
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
72 -ufo1 string UFO features
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
73 -fformat1 string Features format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
74 -fopenfile1 string Features file name
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
75
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
76 "-outfile" associated qualifiers
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
77 -odirectory3 string Output directory
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
78
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
79 General qualifiers:
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
80 -auto boolean Turn off prompts
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
81 -stdout boolean Write first file to standard output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
82 -filter boolean Read first file from standard input, write
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
83 first file to standard output
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
84 -options boolean Prompt for standard and additional values
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
85 -debug boolean Write debug output to program.dbg
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
86 -verbose boolean Report some/full command line options
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
87 -help boolean Report command line options and exit. More
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
88 information on associated and general
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
89 qualifiers can be found with -help -verbose
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
90 -warning boolean Report warnings
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
91 -error boolean Report errors
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
92 -fatal boolean Report fatal errors
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
93 -die boolean Report dying program messages
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
94 -version boolean Report version number and exit
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
95
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
96 Input file format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
97
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
98 The database definitions for following commands are available at
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
99 http://soap.g-language.org/kbws/embossrc
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
100
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
101 gdistincc reads one or more nucleotide sequences.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
102
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
103 Output file format
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
104
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
105 The output from gdistincc is to a plain text file.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
106
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
107 File: nc_000913.gdistincc
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
108
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
109 Sequence: NC_000913 Position1: 1234 Distance 1169193600
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
110
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
111
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
112 Data files
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
113
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
114 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
115
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
116 Notes
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
117
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
118 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
119
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
120 References
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
121
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
122 Arakawa, K., Mori, K., Ikeda, K., Matsuzaki, T., Konayashi, Y., and
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
123 Tomita, M. (2003) G-language Genome Analysis Environment: A Workbench
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
124 for Nucleotide Sequence Data Mining, Bioinformatics, 19, 305-306.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
125
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
126 Arakawa, K. and Tomita, M. (2006) G-language System as a Platform for
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
127 large-scale analysis of high-throughput omics data, J. Pest Sci.,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
128 31, 7.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
129
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
130 Arakawa, K., Kido, N., Oshita, K., Tomita, M. (2010) G-language Genome
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
131 Analysis Environment with REST and SOAP Web Service Interfaces,
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
132 Nucleic Acids Res., 38, W700-W705.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
133
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
134 Warnings
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 Diagnostic Error Messages
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 Exit status
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
143
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
144 It always exits with a status of 0.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
145
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
146 Known bugs
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
147
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
148 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
149
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
150 See also
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
151
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
152 gconsensus_z Calculate consensus in given array of sequences
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
153 gpalindrome Searches palindrome sequences
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
154 gseqinfo Prints out basic nucleotide sequence statistics
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
155
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
156 Author(s)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
157
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
158 Hidetoshi Itaya (celery@g-language.org)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
159 Institute for Advanced Biosciences, Keio University
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
160 252-0882 Japan
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
161
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
162 Kazuharu Arakawa (gaou@sfc.keio.ac.jp)
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
163 Institute for Advanced Biosciences, Keio University
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
164 252-0882 Japan
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
165
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
166 History
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
167
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
168 2012 - Written by Hidetoshi Itaya
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
169 2013 - Fixed by Hidetoshi Itaya
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
170
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
171 Target users
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
172
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
173 This program is intended to be used by everyone and everything, from
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
174 naive users to embedded scripts.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
175
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
176 Comments
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
177
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
178 None.
8300eb051bea Initial upload
ktnyt
parents:
diff changeset
179