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

Initial upload

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/GEMBASSY-1.0.3/doc/text/gb1.txt	Fri Jun 26 05:19:29 2015 -0400
@@ -0,0 +1,190 @@
+                                      gb1
+Function
+
+   Calculate strand bias of bacterial genome using B1 index
+
+Description
+
+   gb1 calculates the strand bias of bacterial genome using B1 index,
+   first proposed by Lobry and Sueoka (2002), and further extended by
+   Rocha et al. (2006). Basic idea of B1 index is to calculate the
+   distance between the two strands, when the leading and lagging strands
+   are plotted in a coordinate system with axes representing G/(G+C) and
+   A/(A+T), using the third codon position of genes. This index measures the
+   degree of replication-induced bias from Chargaff's second parity rule.
+   Rocha et al. modified B1 index to only use >fourfold degenerate codons,
+   and to use T/(A+T) in place of A/(A+T).
+    
+   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 gb1
+
+% gb1 refseqn:NC_000913
+Calculate strand bias of bacterial genome using B1 index
+Program compseq output file [nc_000913.gb1]: 
+
+   Go to the input files for this example
+   Go to the output files for this example
+
+Command line arguments
+
+   Standard (Mandatory) qualifiers:
+  [-sequence]          seqall     Nucleotide sequence(s) filename and optional
+                                  format, or reference (input USA)
+  [-outfile]           outfile    [*.gb1] Program compseq output file
+
+   Additional (Optional) qualifiers: (none)
+   Advanced (Unprompted) qualifiers:
+   -method             selection  [rocha] Choose method of 'lobry' or 'rocha'
+   -[no]accid          boolean    [Y] Include to use sequence accession ID as
+                                  query
+
+   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
+
+   "-outfile" associated qualifiers
+   -odirectory2        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
+
+   gb1 reads one or more nucleotide sequences.
+
+Output file format
+
+   The output from gb1 is to a plain text file.
+
+   File: nc_000913.gb1
+
+Sequence: NC_000913 B1: 0.0630702874711314
+
+
+Data files
+
+   None.
+
+Notes
+
+   None.
+
+References
+
+   Lobry JR and Sueoka N (2002) Asymmetric directional mutation pressures in
+      bacteria, Genome Biology, 3(10):0058
+
+   Rocha EPC et al. (2006) Similar compositional biases are caused by very
+      different mutational effects, Genome Research, 16:1537-1547
+
+   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
+
+   gb2          Calculate strand bias of bacterial genome using B2 index
+   gdeltagcskew Calculate strand bias of bacterial genome using delta GC skew
+                index
+   ggcsi        GC Skew Index: an index for strand-specefic mutational bias
+   gldabias     Calculate strand bias of bacterial genome using linear
+                discriminant analysis (LDA)
+
+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.
+