diff GEMBASSY-1.0.3/doc/text/gbaserelativeentropy.txt @ 0:8300eb051bea draft

Initial upload

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/GEMBASSY-1.0.3/doc/text/gbaserelativeentropy.txt	Fri Jun 26 05:19:29 2015 -0400
@@ -0,0 +1,243 @@
+                              gbaserelativeentropy
+Function
+
+   Calculates and graphs the sequence conservation using Kullback-Leibler
+
+Description
+
+   This function calculates and graphs the sequence conservation in regions
+   around the start/stop codons using Kullback-Leibler divergence (relative
+   entropy). In realistic conditions, as background nucleotide composition
+   (e.g. G+C content) varies among species. Kullback-Leibler divergence
+   calculates the entropy with reduced background noise.
+
+   The relative entropy H at position i with distribution P(i) is calculated
+   as follows:
+   H(P(i)||pi) = sum(P(i,j) * log(2, P(i,j)/pi(j)))
+    
+   G-language SOAP service is provided by the
+   Institute for Advanced Biosciences, Keio University.
+   The original web service is located at the following URL:
+
+   http://www.g-language.org/wiki/soap
+
+   WSDL(RPC/Encoded) file is located at:
+
+   http://soap.g-language.org/g-language.wsdl
+
+   Documentation on G-language Genome Analysis Environment methods are
+   provided at the Document Center
+
+   http://ws.g-language.org/gdoc/
+
+Usage
+
+Here is a sample session with gbaserelativeentropy
+
+% gbaserelativeentropy refseqn:NC_000913
+Calculates and graphs the sequence conservation using Kullback-Leibler
+divergence (relative entropy)
+Program compseq output file (optional) [nc_000913.gbaserelativeentropy]: 
+
+   Go to the input files for this example
+   Go to the output files for this example
+
+   Example 2
+
+% gbaserelativeentropy refseqn:NC_000913 -plot -graph png
+Calculates and graphs the sequence conservation using Kullback-Leibler
+divergence (relative entropy)
+Created gbaserelativeentropy.1.png
+
+   Go to the input files for this example
+   Go to the output files for this example
+
+Command line arguments
+
+Calculates and graphs the sequence conservation using Kullback-Leibler
+divergence (relative entropy)
+Version: EMBOSS:6.5.7.0 GEMBASSY:1.0.1
+
+   Standard (Mandatory) qualifiers (* if not always prompted):
+  [-sequence]          seqall     Nucleotide sequence(s) filename and optional
+                                  format, or reference (input USA)
+*  -graph              xygraph    [$EMBOSS_GRAPHICS value, or x11] Graph type
+                                  (ps, hpgl, hp7470, hp7580, meta, cps, x11,
+                                  tek, tekt, none, data, xterm, png, gif, svg)
+*  -outfile            outfile    [*.gbaserelativeentropy] Program compseq
+                                  output file (optional)
+
+   Additional (Optional) qualifiers: (none)
+   Advanced (Unprompted) qualifiers:
+   -position           selection  [start] Either 'start' (around start codon)
+                                  or 'end' (around stop codon) to create the
+                                  PWM
+   -patlen             integer    [3] Length of oligomer to count (Any integer
+                                  value)
+   -upstream           integer    [30] Length upstream of specified position
+                                  to create PWM (Any integer value)
+   -downstream         integer    [30] Length downstream of specified position
+                                  to create PWM (Any integer value)
+   -[no]accid          boolean    [Y] Include to use sequence accession ID as
+                                  query
+   -plot               toggle     [N] Include to plot result
+
+   Associated qualifiers:
+
+   "-sequence" associated qualifiers
+   -sbegin1            integer    Start of each sequence to be used
+   -send1              integer    End of each sequence to be used
+   -sreverse1          boolean    Reverse (if DNA)
+   -sask1              boolean    Ask for begin/end/reverse
+   -snucleotide1       boolean    Sequence is nucleotide
+   -sprotein1          boolean    Sequence is protein
+   -slower1            boolean    Make lower case
+   -supper1            boolean    Make upper case
+   -scircular1         boolean    Sequence is circular
+   -sformat1           string     Input sequence format
+   -iquery1            string     Input query fields or ID list
+   -ioffset1           integer    Input start position offset
+   -sdbname1           string     Database name
+   -sid1               string     Entryname
+   -ufo1               string     UFO features
+   -fformat1           string     Features format
+   -fopenfile1         string     Features file name
+
+   "-graph" associated qualifiers
+   -gprompt            boolean    Graph prompting
+   -gdesc              string     Graph description
+   -gtitle             string     Graph title
+   -gsubtitle          string     Graph subtitle
+   -gxtitle            string     Graph x axis title
+   -gytitle            string     Graph y axis title
+   -goutfile           string     Output file for non interactive displays
+   -gdirectory         string     Output directory
+
+   "-outfile" associated qualifiers
+   -odirectory         string     Output directory
+
+   General qualifiers:
+   -auto               boolean    Turn off prompts
+   -stdout             boolean    Write first file to standard output
+   -filter             boolean    Read first file from standard input, write
+                                  first file to standard output
+   -options            boolean    Prompt for standard and additional values
+   -debug              boolean    Write debug output to program.dbg
+   -verbose            boolean    Report some/full command line options
+   -help               boolean    Report command line options and exit. More
+                                  information on associated and general
+                                  qualifiers can be found with -help -verbose
+   -warning            boolean    Report warnings
+   -error              boolean    Report errors
+   -fatal              boolean    Report fatal errors
+   -die                boolean    Report dying program messages
+   -version            boolean    Report version number and exit
+
+Input file format
+
+   The database definitions for following commands are available at
+   http://soap.g-language.org/kbws/embossrc
+
+   gbaserelativeentropy reads one or more nucleotide sequences.
+
+Output file format
+
+   The output from gbaserelativeentropy is to a plain text file or the
+   EMBOSS graphics device.
+
+   File: nc_000913.gbaserelativeentropy
+
+Sequence: NC_000913
+-30,-0.46682
+-29,-0.46265
+-28,-0.45732
+-27,-0.45704
+-26,-0.44692
+-25,-0.44396
+-24,-0.43528
+-23,-0.43419
+-22,-0.42518
+
+   [Part of this file has been deleted for brevity]
+
+21,-0.40010
+22,-0.41772
+23,-0.42503
+24,-0.39675
+25,-0.43091
+26,-0.43196
+27,-0.40576
+28,-0.43387
+29,-0.41228
+30,-0.38869
+
+
+Data files
+
+   None.
+
+Notes
+
+   None.
+
+References
+
+   Arakawa, K., Mori, K., Ikeda, K., Matsuzaki, T., Konayashi, Y., and
+      Tomita, M. (2003) G-language Genome Analysis Environment: A Workbench
+      for Nucleotide Sequence Data Mining, Bioinformatics, 19, 305-306.
+
+   Arakawa, K. and Tomita, M. (2006) G-language System as a Platform for
+      large-scale analysis of high-throughput omics data, J. Pest Sci.,
+      31, 7.
+
+   Arakawa, K., Kido, N., Oshita, K., Tomita, M. (2010) G-language Genome
+      Analysis Environment with REST and SOAP Web Service Interfaces,
+      Nucleic Acids Res., 38, W700-W705.
+
+Warnings
+
+   None.
+
+Diagnostic Error Messages
+
+   None.
+
+Exit status
+
+   It always exits with a status of 0.
+
+Known bugs
+
+   None.
+
+See also
+
+   gbase_entropy             Calculates and graphs the sequence conservation
+                             using Shanon uncertainty (entropy)
+   gbase_information_content Calculates and graphs the sequence conservation
+                             using information content
+
+Author(s)
+
+   Hidetoshi Itaya ([e-mail])
+   Institute for Advanced Biosciences, Keio University
+   252-0882 Japan
+
+   Kazuharu Arakawa ([e-mail])
+   Institute for Advanced Biosciences, Keio University
+   252-0882 Japan
+
+History
+
+   2012 - Written by Hidetoshi Itaya
+   2013 - Fixed by Hidetoshi Itaya
+
+Target users
+
+   This program is intended to be used by everyone and everything, from
+   naive users to embedded scripts.
+
+Comments
+
+   None.
+