forester/archive/RIO/others/hmmer/testsuite/README

   1 Shiva: HMMER testsuite
   2
   3 #####################################################################
   4 I. Compiled test drivers.
   5 ---------------------------------------------------------------------
   6
   7 - A test driver runs with no arguments, gives no output,
   8   and returns EXIT_SUCCESS if the test passes.
   9 - If the test fails, the test driver calls Die() to print a diagnostic on
  10   stderr, and exit with EXIT_FAILURE.
  11 - The -v option always activates rudimentary verbose output on stdout.
  12
  13
  14 Current tests:
  15 ---------------
  16
  17 alignalign_test
  18         Exercises P7ViterbiAlignAlignment() -- alignment of a fixed
  19         multiple alignment to an HMM. Aligns fn3 seed alignment to
  20         fn3 model, compares to results of aligning sequences individually;
  21         if an excessive number of discrepancies are detected, test
  22         fails.
  23         Other files: fn3.seed, fn3.hmm.
  24
  25 evd_test
  26         Exercises code in histogram.c, especially EVD fitting
  27         Default generates 1000 EVD samples; fits EVD; tests that fitted
  28         parameters are reasonably close to real ones.
  29
  30 masks_test
  31         Exercises code in masks.c
  32         Default runs XNU on a sequence and compares to a known result.
  33
  34 parsingviterbi_test
  35         Exercises P7ParsingViterbi() in core_algorithms.c
  36         Runs Fn3 model against titin using both standard Viterbi and
  37         ParsingViterbi; compares results for identity.
  38
  39 tophits_test
  40         Exercises tophits.c
  41         Generates random scores in three tiers (good, middling, bad).
  42         Uses RegisterHit() API; FullSort's them; tests that they
  43         end up in the right number/order.
  44
  45 trace_test
  46         Exercises traceback code in core_algorithms.c
  47         Runs a simple HMM against synthetic sequences designed to
  48         exercise all possible arrangements of transitions, and
  49         does a TraceVerify() to be sure resulting trace is internally
  50         consistent.
  51
  52 viterbi_exercise
  53         Exercises P7Viterbi and P7SmallViterbi in core_algorithms.c
  54         Configures Fn3 model into various modes; generates 100 random
  55         seqs from each configuration; does P7Viterbi and P7SmallViterbi
  56         alignments, TraceVerify()'s them, checks them for identity.
  57
  58 weeviterbi_test
  59         Exercises P7WeeViterbi in core_algorithms.c
  60         Runs RRM model against two subsequences of human U1A;
  61         compares Viterbi trace to WeeViterbi trace.
  62
  63 #####################################################################
  64 II. Scripted test drivers.
  65 ---------------------------------------------------------------------
  66
  67 Optiontests.pl
  68         Runs every documented option for every program, to be
  69         sure they're really connected up.
  70
  71
  72 #####################################################################
  73 Obsolete: kept in RCS archive only for reproducibility of old results
  74 ---------------------------------------------------------------------
  75
  76 fitting_test.c  Tests of EVD and Gaussian histogram fitting code.
  77                 17 June 1997
  78
  79
  80
  81
  82