binaries/help/AACon_manual.txt

   1
   2 AA Conservation version 1.0b (2 September 2010)
   3
   4 This program allows calculation of conservation of amino acids in
   5 multiple sequence alignments.
   6 It implements 17 different conservation scores as described by Valdar in
   7 his paper (Scoring Residue Conservation, PROTEINS: Structure, Function
   8 and  Bioinformatics 48:227-241 (2002)) and SMERFS scoring algorithm as described
   9 by Manning, Jefferson and Barton (The contrasting properties of conservation
  10 and correlated phylogeny in protein functional residue prediction,
  11 BMC Bioinformatics (2008)).
  12
  13 The conservation algorithms supported are:
  14
  15 KABAT, JORES, SCHNEIDER, SHENKIN, GERSTEIN, TAYLOR_GAPS, TAYLOR_NO_GAPS,
  16 ZVELIBIL, KARLIN, ARMON, THOMPSON, NOT_LANCET, MIRNY, WILLIAMSON,
  17 LANDGRAF, SANDER, VALDAR, SMERFS
  18
  19 Input format is either a FASTA formatted file containing aligned sequences with
  20 gaps or a Clustal alignment. The valid gap characters are *, -, space character,
  21 X and . (a dot). By default program prints the results to the command window.
  22 If the output file is provided the results are printed to the file in two
  23 possible formats with or without an alignment.
  24 If format is not specified, the program outputs conservation scores without
  25 alignment. The scores are not normalized by default but they can be (see below).
  26 SMERFS default parameters are window width of 7, column score is set to
  27 the middle column (MID_SCORE), gap% cutoff of 0.1. Different parameters for SMERFS
  28 can be provided (see below). Details of the program execution can be recorded to
  29 a separate file if an appropriate file path is provided.
  30
  31 List of command line arguments:
  32
  33 -m=  precedes a comma separated list of method names
  34      EXAMPLE: -m=KABAT,JORES,GERSTEIN
  35      Optional, if no method is specified request for all is assumed.
  36
  37 -i=  precedes a full path to the input FASTA file, required
  38
  39 -o=  precedes a full path to the output file, optional, if no output file is
  40      provided the program will output to the standard out.
  41
  42 -t=  precedes the number of CPUs (CPU cores more precisely) to use. Optional,
  43          defaults to all processors available on the machine.
  44
  45 -f=  precedes the format  of the results in the output file
  46      two different formats are possible:
  47       RESULT_WITH_ALIGNMENT
  48       RESULT_NO_ALIGNMENT
  49      Optional, if not specified RESULT_NO_ALIGNMENT is assumed
  50
  51 -d=  precedes a full path to a file where program execution details are to be
  52      listed. Optional, if not provided, no execution statistics is produced.
  53
  54 -g=  precedes comma separated list of gap characters provided by the user, if
  55      you're using an unusual gap character (not a -,., ,*,X) you have to
  56      provide it. If you you provide this list you have to list all the gaps
  57      accepted. Including those that were previously treated as a default.
  58      Optional.
  59
  60 -n   using this key causes the results to be normalized.
  61          Normalized results have values between 0 and 1. Please note however, that
  62          some results cannot be normalized. In such a case, the system returns not
  63          normalized value, and log the issue to the standard error stream.
  64          The following formula is used for normalization
  65                         n = (d - dmin)/(dmax - dmin)
  66          Negative results first converted to positive by adding an absolute value of
  67          the most negative result. Optional.
  68
  69 SMERFS Only Parameters:
  70
  71 -smerfsGT=  precedes SMERFS Gap Treshold - a gap percentage cutoff -
  72                         a float greater than 0 and smaller or equal 1. Optional defaults
  73                         to 0.1
  74
  75 -smerfsCS=  precedes SMERFS Column Score algorithm defines the window scores to
  76                         columns allocation , two methods are possible:
  77                 MID_SCORE - gives the window score to the middle column
  78                 MAX_SCORE - gives the column the highest score of all the windows it
  79                 belongs to. Optional defaults to MID_SCORE.
  80
  81 -smerfsWW=  precedes Window Width parameter - an integer and an odd number.
  82             Optional, defaults to 7
  83
  84
  85 EXAMPLE HOW TO RUN THE PROGRAM:
  86 java -jar <jar name> -m=KABAT,SMERFS -i=prot1 -o=prot1_results -n
  87
  88 As a result of the execution KABAT and SMERFS scores will be calculated.
  89 Input comes form prot1 file and an output without an alignment is recorded to
  90 prot1_results file.
  91
  92 Authors: Peter Troshin, Agnieszka Golicz, David Martin and Geoff Barton.
  93 Please visit http://www.compbio.dundee.ac.uk/aacon for further information.
  94