conf/settings/TcoffeeParameters.xml

   1 <?xml version="1.0" encoding="US-ASCII" standalone="yes"?>\r
   2 <runnerConfig>\r
   3  <runnerClassName>compbio.runner.tcoffee.Tcoffee</runnerClassName>\r
   4 \r
   5     <options isRequired="false">\r
   6         <name>Search sequences in PDB</name>\r
   7         <description>\r
   8                 Forces t_coffee to run extract_from_pdb to check the pdb status of each sequence.\r
   9                 This can considerably slow down the program.\r
  10         </description>\r
  11         <optionNames>-check_pdb_status</optionNames>\r
  12         <furtherDetails>prog_docs/tcoffee.html</furtherDetails>\r
  13    </options>\r
  14 \r
  15    <prmSeparator>=</prmSeparator>\r
  16    <!--\r
  17       ERROR: When using -evaluate, Provide a multiple sequence alignment via the -infile flag [FATAL:T-COFFEE] \r
  18       mcoffee: compares alignmens obtained by different programmes\r
  19    -->\r
  20     <parameters isRequired="false">\r
  21         <name>Preset Mode</name>\r
  22         <description>\r
  23             It indicates that t_coffee will use some hard coded parameters. \r
  24             These include: quickaln: Very fast, sequence type - all, accuracy - medium low \r
  25         </description>\r
  26         <furtherDetails>prog_docs/tcoffee.html</furtherDetails>\r
  27         <optionNames>-mode</optionNames>\r
  28         <defaultValue>quickaln</defaultValue>\r
  29         <possibleValues>quickaln</possibleValues>\r
  30     </parameters>\r
  31     <!--\r
  32     All the options below need proper installation!\r
  33     rcoffee does not work as it fails to find the "templates" \r
  34     <description>\r
  35           This require blast to be setup properly see also Presets\r
  36            dali: a mode used to combine dali pairwise alignments\r
  37               3dcoffee: runs t_coffee with the 3dcoffee parameterization\r
  38            accurate: slow, sequence type - protein, accuracy - high\r
  39        expresso: slow, sequence type - all, accuracy - high\r
  40            rcoffee: slow, sequence type - RNA, accuracy - high\r
  41         </description>\r
  42            <possibleValues>expresso</possibleValues>\r
  43     <possibleValues>dali</possibleValues>\r
  44     <possibleValues>3dcoffee</possibleValues>\r
  45     <possibleValues>accurate</possibleValues>\r
  46     <possibleValues>rcoffee</possibleValues>\r
  47      -->\r
  48 <!-- Parameter with textual value \r
  49     <parameters isRequired="false">\r
  50         <name>Structures</name>\r
  51         <description>Reads or fetch a pdb file. Please enter up to 200 pdb identifiers </description>\r
  52         <optionNames>-pdb</optionNames>\r
  53         <furtherDetails>http://www.compbio.dundee.ac.uk/users/pvtroshin/ws/Index.html</furtherDetails>\r
  54     </parameters>\r
  55     -->\r
  56     <parameters isRequired="false">\r
  57         <name>Distance matrix computation method</name>\r
  58         <description>\r
  59             This flag indicates the method used for computing the distance matrix (distance between \r
  60             every pair of sequences) required for the computation of the dendrogram. \r
  61             Slow -      The chosen dp_mode using the extended library, \r
  62             fast -      The fasta dp_mode using the extended library.\r
  63             very_fast - The fasta dp_mode using blosum62mt.\r
  64             ktup -      Ktup matching (Muscle kind) \r
  65             aln  -      Read the distances on a precomputed MSA\r
  66         </description>\r
  67         <optionNames>-distance_matrix_mode</optionNames>\r
  68         <furtherDetails>prog_docs/tcoffee.html</furtherDetails>\r
  69         <defaultValue>very_fast</defaultValue>\r
  70         <possibleValues>slow</possibleValues>\r
  71         <possibleValues>fast</possibleValues>\r
  72         <possibleValues>very_fast</possibleValues>\r
  73         <possibleValues>ktup</possibleValues>\r
  74         <possibleValues>aln</possibleValues>\r
  75     </parameters>\r
  76 \r
  77     <parameters isRequired="false">\r
  78         <name>Tree Computation method</name>\r
  79         <description>\r
  80             gotoh_pair_wise: implementation of the gotoh algorithm (quadratic in memory and time)\r
  81             myers_miller_pair_wise: implementation of the Myers and Miller dynamic programming \r
  82             algorithm ( quadratic in time and linear in space). This algorithm is recommended for \r
  83             very long sequences. It is about 2 times slower than gotoh and only accepts tg_mode=1 \r
  84             or 2 (i.e. gaps penalized for opening).\r
  85             fasta_pair_wise: implementation of the fasta algorithm. The sequence is hashed, looking \r
  86             for ktuples words. Dynamic programming is only carried out on the ndiag best scoring \r
  87             diagonals. This is much faster but less accurate than the two previous. This mode is \r
  88             controlled by the parameters -ktuple, -diag_mode and -ndiag\r
  89             cfasta_pair_wise: c stands for checked. It is the same algorithm. The dynamic programming \r
  90             is made on the ndiag best diagonals, and then on the 2*ndiags, and so on until the scores \r
  91             converge. Complexity will depend on the level of divergence of the sequences, but will \r
  92             usually be L*log(L), with an accuracy comparable to the two first mode ( this was checked \r
  93             on BaliBase). This mode is controlled by the parameters -ktuple, -diag_mode and -ndiag\r
  94         </description>\r
  95         <optionNames>-dp_mode</optionNames>\r
  96         <furtherDetails>prog_docs/tcoffee.html</furtherDetails>\r
  97         <defaultValue>cfasta_pair_wise</defaultValue>\r
  98         <possibleValues>gotoh_pair_wise</possibleValues>\r
  99         <possibleValues>myers_miller_pair_wise</possibleValues>\r
 100         <possibleValues>fasta_pair_wise</possibleValues>\r
 101         <possibleValues>cfasta_pair_wise</possibleValues>\r
 102     </parameters>\r
 103 <!-- This should be groupped with -dp_mode -->\r
 104 \r
 105     <parameters isRequired="false">\r
 106         <name>Number of diagonals used by the fasta_pair_wise algorithm</name>\r
 107         <description>\r
 108             Indicates the number of diagonals used by the fasta_pair_wise algorithm (cf -dp_mode). When  -ndiag=0, n_diag=Log (length of the smallest sequence)+1. \r
 109             When -ndiag and -diag_threshold are set, diagonals are selected if and only if they fulfill both conditions.\r
 110         </description>\r
 111         <optionNames>-ndiag</optionNames>\r
 112         <furtherDetails>prog_docs/tcoffee.html</furtherDetails>\r
 113         <defaultValue>0</defaultValue>\r
 114         <validValue>\r
 115             <type>Integer</type>\r
 116             <min>0</min>\r
 117             <max>1000</max>\r
 118         </validValue>\r
 119     </parameters>\r
 120 \r
 121     <parameters isRequired="false">\r
 122         <name>Number of diagonals used by the fasta_pair_wise algorithm</name>\r
 123         <description>\r
 124             Indicates the manner in which diagonals are scored during the fasta hashing. \r
 125             0 indicates that the score of a diagonal is equal to the sum of the scores of the exact matches it contains. \r
 126             1 indicates that this score is set equal to the score of the best uninterrupted segment \r
 127             (useful when dealing with fragments of sequences).\r
 128         </description>\r
 129         <optionNames>-diag_mode</optionNames>\r
 130         <furtherDetails>prog_docs/tcoffee.html</furtherDetails>\r
 131         <defaultValue>0</defaultValue>\r
 132         <possibleValues>0</possibleValues>\r
 133         <possibleValues>1</possibleValues>\r
 134     </parameters>\r
 135 \r
 136     <parameters isRequired="false">\r
 137         <name>Diagonal threshold</name>\r
 138         <description>\r
 139             Sets the value of the threshold when selecting diagonals. \r
 140             0: indicates that -ndiag should be used to select the diagonals (cf -ndiag section).\r
 141         </description>\r
 142         <optionNames>-diag_threshold</optionNames>\r
 143         <furtherDetails>prog_docs/tcoffee.html</furtherDetails>\r
 144         <defaultValue>0</defaultValue>\r
 145         <validValue>\r
 146             <type>Integer</type>\r
 147             <min>0</min>\r
 148             <max>1000</max>\r
 149         </validValue>\r
 150     </parameters>\r
 151 \r
 152     <parameters isRequired="false">\r
 153         <name>Alphabet degeneration method</name>\r
 154         <description>\r
 155             Indicates the manner in which the amino acid alphabet is degenerated when hashing in the \r
 156             fasta_pairwise dynamic programming. Standard ClustalW matrices are all valid. \r
 157             They are used to define groups of amino acids having positive substitution values. \r
 158             In T-Coffee, the default is a 13 letter grouping named Vasiliky, with residues grouped as follows:\r
 159             rk, de, qh, vilm, fy (other residues kept alone).\r
 160             This alphabet is set with the flag -sim_matrix=vasiliky. \r
 161             In order to keep the alphabet non degenerated, -sim_matrix=idmat can be used to retain \r
 162             the standard alphabet.\r
 163         </description>\r
 164         <optionNames>-sim_matrix</optionNames>\r
 165         <furtherDetails>prog_docs/tcoffee.html</furtherDetails>\r
 166         <defaultValue>vasiliky</defaultValue>\r
 167         <possibleValues>vasiliky</possibleValues>\r
 168         <possibleValues>idmat</possibleValues>\r
 169     </parameters>\r
 170 \r
 171     <parameters isRequired="false">\r
 172         <name>Substitution Matrix</name>\r
 173         <description>\r
 174             This flag sets the matrix that will be used by alignment methods within t_coffee (slow_pair, lalign_id_pair).\r
 175             It does not affect external methods (like clustal_pair, clustal_aln). \r
 176             Users can also provide their own matrices, using the matrix format described in the appendix.\r
 177         </description>\r
 178         <optionNames>-matrix</optionNames>\r
 179         <furtherDetails>prog_docs/tcoffee.html</furtherDetails>\r
 180         <possibleValues>blosum62mt</possibleValues>\r
 181          <!-- This option causes tcoffee to fail\r
 182          <parameters isRequired="false">\r
 183         <name>Matrix</name>\r
 184         <description>Substitution Matrix to use</description>\r
 185         <optionNames>-matrix</optionNames>\r
 186         <furtherDetails>http://www.compbio.dundee.ac.uk/users/pvtroshin/ws/Index.html</furtherDetails>\r
 187         <defaultValue>BLOSUM62</defaultValue>\r
 188                 <possibleValues>BLOSUM100</possibleValues>\r
 189                 <possibleValues>BLOSUM30</possibleValues>\r
 190                 <possibleValues>BLOSUM35</possibleValues>\r
 191                 <possibleValues>BLOSUM40</possibleValues>\r
 192                 <possibleValues>BLOSUM45</possibleValues>\r
 193                 <possibleValues>BLOSUM50</possibleValues>\r
 194                 <possibleValues>BLOSUM55</possibleValues>\r
 195                 <possibleValues>BLOSUM60</possibleValues>\r
 196                 <possibleValues>BLOSUM62</possibleValues>\r
 197                 <possibleValues>BLOSUM65</possibleValues>\r
 198                 <possibleValues>BLOSUM70</possibleValues>\r
 199                 <possibleValues>BLOSUM75</possibleValues>\r
 200                 <possibleValues>BLOSUM80</possibleValues>\r
 201                 <possibleValues>BLOSUM85</possibleValues>\r
 202                 <possibleValues>BLOSUM90</possibleValues>\r
 203                 <possibleValues>BLOSUMN</possibleValues>\r
 204                 <possibleValues>DAYHOFF</possibleValues>\r
 205                 <possibleValues>GONNET</possibleValues>\r
 206                 <possibleValues>IDENTITY</possibleValues>\r
 207                 <possibleValues>MATCH</possibleValues>\r
 208                 <possibleValues>NUC.4.2</possibleValues>\r
 209                 <possibleValues>NUC.4.4</possibleValues>\r
 210                 <possibleValues>PAM10</possibleValues>\r
 211                 <possibleValues>PAM100</possibleValues>\r
 212                 <possibleValues>PAM110</possibleValues>\r
 213                 <possibleValues>PAM120</possibleValues>\r
 214                 <possibleValues>PAM130</possibleValues>\r
 215                 <possibleValues>PAM140</possibleValues>\r
 216                 <possibleValues>PAM150</possibleValues>\r
 217                 <possibleValues>PAM160</possibleValues>\r
 218                 <possibleValues>PAM170</possibleValues>\r
 219                 <possibleValues>PAM180</possibleValues>\r
 220                 <possibleValues>PAM190</possibleValues>\r
 221                 <possibleValues>PAM20</possibleValues>\r
 222                 <possibleValues>PAM200</possibleValues>\r
 223                 <possibleValues>PAM210</possibleValues>\r
 224                 <possibleValues>PAM220</possibleValues>\r
 225                 <possibleValues>PAM230</possibleValues>\r
 226                 <possibleValues>PAM240</possibleValues>\r
 227                 <possibleValues>PAM250</possibleValues>\r
 228                 <possibleValues>PAM260</possibleValues>\r
 229                 <possibleValues>PAM270</possibleValues>\r
 230                 <possibleValues>PAM280</possibleValues>\r
 231                 <possibleValues>PAM290</possibleValues>\r
 232                 <possibleValues>PAM30</possibleValues>\r
 233                 <possibleValues>PAM300</possibleValues>\r
 234                 <possibleValues>PAM310</possibleValues>\r
 235                 <possibleValues>PAM320</possibleValues>\r
 236                 <possibleValues>PAM330</possibleValues>\r
 237                 <possibleValues>PAM340</possibleValues>\r
 238                 <possibleValues>PAM350</possibleValues>\r
 239                 <possibleValues>PAM360</possibleValues>\r
 240                 <possibleValues>PAM370</possibleValues>\r
 241                 <possibleValues>PAM380</possibleValues>\r
 242                 <possibleValues>PAM390</possibleValues>\r
 243                 <possibleValues>PAM40</possibleValues>\r
 244                 <possibleValues>PAM400</possibleValues>\r
 245                 <possibleValues>PAM410</possibleValues>\r
 246                 <possibleValues>PAM420</possibleValues>\r
 247                 <possibleValues>PAM430</possibleValues>\r
 248                 <possibleValues>PAM440</possibleValues>\r
 249                 <possibleValues>PAM450</possibleValues>\r
 250                 <possibleValues>PAM460</possibleValues>\r
 251                 <possibleValues>PAM470</possibleValues>\r
 252                 <possibleValues>PAM480</possibleValues>\r
 253                 <possibleValues>PAM490</possibleValues>\r
 254                 <possibleValues>PAM50</possibleValues>\r
 255                 <possibleValues>PAM500</possibleValues>\r
 256                 <possibleValues>PAM60</possibleValues>\r
 257                 <possibleValues>PAM70</possibleValues>\r
 258                 <possibleValues>PAM80</possibleValues>\r
 259                 <possibleValues>PAM90</possibleValues>\r
 260    </parameters>\r
 261     -->\r
 262     </parameters>\r
 263 \r
 264     <parameters isRequired="false">\r
 265         <name>Match penalty</name>\r
 266         <description>\r
 267             Indicates the penalty to associate with a match. When using a library, \r
 268             all matches are positive or equal to 0. Matches equal to 0 are unsupported by the \r
 269             library but non-penalized. Setting nomatch to a non-negative value makes it possible \r
 270             to penalize these null matches and prevent unrelated sequences from being aligned \r
 271             (this can be useful when the alignments are meant to be used for structural modeling)</description>\r
 272         <optionNames>-nomatch</optionNames>\r
 273         <furtherDetails>prog_docs/tcoffee.html</furtherDetails>\r
 274         <defaultValue>0</defaultValue>\r
 275         <validValue>\r
 276             <type>Integer</type>\r
 277             <min>0</min>\r
 278             <max>1000</max>\r
 279         </validValue>\r
 280     </parameters>\r
 281 \r
 282     <parameters isRequired="false">\r
 283         <name>Gap opening penalty</name>\r
 284         <description>\r
 285             Indicates the penalty applied for opening a gap. The penalty must be negative. \r
 286             If no value is provided when using a substitution matrix, a value will be automatically computed.\r
 287             Here are some guidelines regarding the tuning of gapopen and gapext. \r
 288             In T-Coffee matches get a score between 0 (match) and 1000 (match perfectly consistent with the library).\r
 289             The default cosmetic penalty is set to -50 (5% of a perfect match). \r
 290             If you want to tune -gapoen and see a strong effect, you should therefore consider values between 0 and -1000. \r
 291         </description>\r
 292         <optionNames>-gapopen</optionNames>\r
 293         <furtherDetails>prog_docs/tcoffee.html</furtherDetails>\r
 294         <defaultValue>0</defaultValue>\r
 295         <validValue>\r
 296             <type>Integer</type>\r
 297             <min>-1000</min>\r
 298             <max>0</max>\r
 299         </validValue>\r
 300     </parameters>\r
 301 \r
 302     <parameters isRequired="false">\r
 303         <name>Gap extension penalty</name>\r
 304         <description>\r
 305             Indicates the penalty applied for extending a gap. The penalty must be negative. \r
 306         </description>\r
 307         <optionNames>-gapext</optionNames>\r
 308         <furtherDetails>prog_docs/tcoffee.html</furtherDetails>\r
 309         <defaultValue>0</defaultValue>\r
 310         <validValue>\r
 311             <type>Integer</type>\r
 312             <min>-1000</min>\r
 313             <max>0</max>\r
 314         </validValue>\r
 315    </parameters>\r
 316 \r
 317     <parameters isRequired="false">\r
 318         <name>Cosmetic penalty</name>\r
 319         <description>\r
 320         Indicates the penalty applied for opening a gap. The penalty must be negative and is set to a very low value by default.\r
 321         It will only have an influence on the portions of the alignment that are unalignable. \r
 322         It will not make them more correct, but only more pleasing to the eye ( i.e. Avoid stretches \r
 323         of lonely residues). The cosmetic penalty is automatically turned off if a substitution matrix is \r
 324         used rather than a library.\r
 325         </description>\r
 326         <optionNames>-cosmetic_penalty</optionNames>\r
 327         <furtherDetails>prog_docs/tcoffee.html</furtherDetails>\r
 328         <defaultValue>-50</defaultValue>\r
 329         <validValue>\r
 330             <type>Integer</type>\r
 331             <min>-1000</min>\r
 332             <max>0</max>\r
 333         </validValue>\r
 334     </parameters>\r
 335 \r
 336     <parameters isRequired="false">\r
 337         <name>Terminal gaps penalty</name>\r
 338         <description>\r
 339                 0: terminal gaps penalized with -gapopen + -gapext*len\r
 340                 1: terminal gaps penalized with a -gapext*len\r
 341                 2: terminal gaps unpenalized.\r
 342         </description>\r
 343         <optionNames>-tg_mode</optionNames>\r
 344         <furtherDetails>prog_docs/tcoffee.html</furtherDetails>\r
 345                 <defaultValue>1</defaultValue>\r
 346                 <possibleValues>0</possibleValues>\r
 347                 <possibleValues>1</possibleValues>\r
 348                 <possibleValues>2</possibleValues>\r
 349     </parameters>\r
 350 \r
 351     <parameters isRequired="false">\r
 352         <name>Number of iterations</name>\r
 353         <description>\r
 354             Sequences are extracted in turn and realigned to the MSA. \r
 355             If iterate is set to -1, each sequence is realigned, otherwise the number of iterations is \r
 356             set by -iterate.\r
 357         </description>\r
 358         <optionNames>-iterate</optionNames>\r
 359         <furtherDetails>prog_docs/tcoffee.html</furtherDetails>\r
 360             <defaultValue>0</defaultValue>\r
 361         <validValue>\r
 362             <type>Integer</type>\r
 363             <min>-1</min>\r
 364             <max>100</max>\r
 365         </validValue>\r
 366    </parameters>\r
 367 \r
 368   <parameters isRequired="false">\r
 369         <name>Output order</name>\r
 370         <description>\r
 371             Sets the order of the sequences in the output alignment: -outorder=input means the sequences \r
 372             are kept in the original order. -outorder=aligned means the sequences come in the order \r
 373             indicated by the tree. This order can be seen as a one-dimensional projection of the tree distances. \r
 374         </description>\r
 375         <optionNames>-outorder</optionNames>\r
 376         <furtherDetails>prog_docs/tcoffee.html</furtherDetails>\r
 377             <defaultValue>input</defaultValue>\r
 378             <possibleValues>input</possibleValues>\r
 379             <possibleValues>aligned</possibleValues>\r
 380     </parameters>\r
 381 \r
 382     <parameters isRequired="false">\r
 383         <name>Input order</name>\r
 384         <description>\r
 385             Multiple alignments based on dynamic programming depend slightly on the order in which \r
 386             the incoming sequences are provided. To prevent this effect sequences are arbitrarily \r
 387             sorted at the beginning of the program (-inorder=aligned). \r
 388             However, this affects the sequence order within the library. \r
 389             You can switch this off by setting -inorder=input\r
 390         </description>\r
 391         <optionNames>-inorder</optionNames>\r
 392         <furtherDetails>prog_docs/tcoffee.html</furtherDetails>\r
 393             <defaultValue>aligned</defaultValue>\r
 394             <possibleValues>input</possibleValues>\r
 395             <possibleValues>aligned</possibleValues>\r
 396    </parameters>\r
 397 </runnerConfig>\r