alg/test/test_mussa.cpp

   1 #include <boost/test/auto_unit_test.hpp>
   2 #include <boost/filesystem/path.hpp>
   3 #include <boost/filesystem/operations.hpp>
   4 namespace fs = boost::filesystem;
   5 #include <boost/assign/list_of.hpp>
   6 #include <boost/assign/list_inserter.hpp>
   7 #include <boost/assign.hpp>
   8 namespace assign = boost::assign;
   9
  10 #include <string>
  11 #include <sstream>
  12 #include <vector>
  13
  14 #include "alg/mussa.hpp"
  15 #include "mussa_exceptions.hpp"
  16
  17 using namespace std;
  18
  19 //! can we initialize a mussa object?
  20 BOOST_AUTO_TEST_CASE( mussa_simple )
  21 {
  22   Mussa m;
  23   BOOST_CHECK_EQUAL(m.empty(), true);
  24   BOOST_CHECK_EQUAL(m.get_name(), "" );
  25   BOOST_CHECK_EQUAL(m.get_window(), 0);
  26   BOOST_CHECK_EQUAL(m.get_threshold(), 0);
  27   BOOST_CHECK_EQUAL(m.get_analysis_mode(), Mussa::TransitiveNway);
  28   m.set_name( "hello" );
  29   BOOST_CHECK_EQUAL(m.get_name(), "hello" );
  30   m.set_window(30);
  31   BOOST_CHECK_EQUAL(m.get_window(), 30);
  32   m.set_threshold(21);
  33   BOOST_CHECK_EQUAL(m.get_threshold(), 21);
  34   BOOST_CHECK_EQUAL(m.get_soft_threshold(), 21);
  35   m.set_soft_threshold(19);
  36   BOOST_CHECK_EQUAL(m.get_soft_threshold(), 21);
  37   m.set_soft_threshold(35);
  38   BOOST_CHECK_EQUAL(m.get_soft_threshold(), 30);
  39   m.set_soft_threshold(25);
  40   BOOST_CHECK_EQUAL(m.get_soft_threshold(), 25);
  41   m.set_analysis_mode(Mussa::RadialNway);
  42   BOOST_CHECK_EQUAL(m.get_analysis_mode(), Mussa::RadialNway);
  43   // make sure our path is empty
  44   BOOST_CHECK_EQUAL(m.get_analysis_path().string(), fs::path().string() );
  45
  46   m.clear();
  47   BOOST_CHECK_EQUAL(m.get_name(), "" );
  48   BOOST_CHECK_EQUAL(m.get_window(), 0);
  49   BOOST_CHECK_EQUAL(m.get_threshold(), 0);
  50   BOOST_CHECK_EQUAL(m.get_analysis_mode(), Mussa::TransitiveNway);
  51 }
  52
  53 BOOST_AUTO_TEST_CASE ( mussa_title )
  54 {
  55   Mussa m;
  56
  57   BOOST_CHECK_EQUAL( m.get_title(), "Unnamed");
  58   string foo("foo");
  59   m.set_name(foo);
  60   BOOST_CHECK_EQUAL( m.get_title(), foo);
  61   string foopath_name("/my/silly/path");
  62   fs::path foopath(foopath_name);
  63   m.set_analysis_path(foopath);
  64   BOOST_CHECK_EQUAL( m.get_title().size(), 14);
  65 }
  66
  67 BOOST_AUTO_TEST_CASE( mussa_analysis_name )
  68 {
  69   Mussa m;
  70   m.set_analysis_mode( Mussa::TransitiveNway );
  71   BOOST_CHECK_EQUAL( m.get_analysis_mode_name(), "Transitive" );
  72   m.set_analysis_mode( Mussa::RadialNway );
  73   BOOST_CHECK_EQUAL( m.get_analysis_mode_name(), "Radial" );
  74   m.set_analysis_mode( Mussa::EntropyNway );
  75   BOOST_CHECK_EQUAL( m.get_analysis_mode_name(), "Entropy" );
  76   m.set_analysis_mode( Mussa::RecursiveNway);
  77   BOOST_CHECK_EQUAL( m.get_analysis_mode_name(), "[deprecated] Recursive" );
  78 }
  79
  80 BOOST_AUTO_TEST_CASE( mussa_sequences )
  81 {
  82   std::string s0("AAAANNNN");
  83   std::string s1("GGGGNNNN");
  84   std::string s2("TTTTNNNN");
  85
  86   Mussa analysis;
  87   BOOST_CHECK_EQUAL(analysis.empty(), true);
  88   analysis.append_sequence(s0);
  89   analysis.append_sequence(s1);
  90   analysis.append_sequence(s2);
  91
  92   BOOST_CHECK_EQUAL( analysis.empty(), false);
  93   BOOST_CHECK_EQUAL( analysis.sequences().size(), 3 );
  94   BOOST_CHECK_EQUAL( *(analysis.sequences()[0]), s0);
  95   BOOST_CHECK_EQUAL( *(analysis.sequences()[1]), s1);
  96   BOOST_CHECK_EQUAL( *(analysis.sequences()[2]), s2);
  97 }
  98
  99 // for some reason we can call nway once safely but it
 100 // somehow changed things and caused a segfault
 101 // fixed by adding a return statement in trans_path_search
 102 BOOST_AUTO_TEST_CASE ( empty_mussa_set_threshold )
 103 {
 104   Mussa m;
 105   m.set_soft_threshold(15);
 106   m.nway();
 107
 108   m.set_soft_threshold(25);
 109   m.nway();
 110 }
 111
 112 BOOST_AUTO_TEST_CASE( mussa_load_mupa )
 113 {
 114   fs::path mupa_path(EXAMPLE_DIR, fs::native);
 115   fs::path result_path = fs::initial_path() / "mck3test_w30_t20";
 116   mupa_path /= "mck3test.mupa";
 117
 118   Mussa m1;
 119   m1.load_mupa_file( mupa_path );
 120   m1.analyze();
 121   m1.save( result_path );
 122   BOOST_CHECK_EQUAL( m1.empty(), false);
 123   BOOST_CHECK_EQUAL( m1.get_name(), std::string("mck3test") );
 124   BOOST_CHECK( m1.size() > 0 );
 125   BOOST_CHECK_EQUAL( m1.get_analysis_path().string(), result_path.string());
 126
 127   Mussa m2;
 128   m2.load( result_path );
 129   BOOST_CHECK_EQUAL( m2.empty(), false);
 130   BOOST_CHECK_EQUAL( m2.get_name(), result_path.leaf() );
 131   BOOST_CHECK_EQUAL( m1.size(), m2.size() );
 132   BOOST_CHECK_EQUAL( result_path.string(), m2.get_analysis_path().string() );
 133
 134   // check clear a bit
 135   m2.clear();
 136   BOOST_CHECK_EQUAL( m2.empty(), true);
 137   BOOST_CHECK_EQUAL( m2.is_dirty(), false );
 138   BOOST_CHECK_EQUAL( m2.get_analysis_path().string(), fs::path().string());
 139 }
 140
 141 BOOST_AUTO_TEST_CASE( mussa_load_full_path )
 142 {
 143   Mussa m1;
 144   fs::path full_path(fs::path(EXAMPLE_DIR, fs::native) / "mck3test.mupa");
 145   m1.load_mupa_file( full_path );
 146   m1.analyze();
 147
 148   BOOST_CHECK( m1.size() > 0);
 149   BOOST_CHECK_EQUAL( m1.get_window(), 30 );
 150   BOOST_CHECK_EQUAL( m1.get_threshold(), 20);
 151   BOOST_CHECK_EQUAL( m1.is_dirty(), true);
 152   BOOST_CHECK_EQUAL( m1.get_analysis_path().string(), "");
 153 }
 154
 155 // make sure we know that mupa files cannot be directories
 156 BOOST_AUTO_TEST_CASE( mussa_mupa_is_file_not_directory )
 157 {
 158   fs::path curdir(".");
 159   Mussa m1;
 160   BOOST_CHECK_THROW(m1.load_mupa_file( curdir ), mussa_load_error );
 161 }
 162
 163 BOOST_AUTO_TEST_CASE( mussa_load_analysis )
 164 {
 165   fs::path example_dir(EXAMPLE_DIR, fs::native);
 166   Mussa m1;
 167   m1.load_mupa_file( example_dir / "mck3test.mupa" );
 168   m1.analyze();
 169
 170   Mussa m2;
 171   fs::path analysis_path = fs::initial_path() / "mck3test_w30_t20";
 172   m2.load( analysis_path );
 173
 174   BOOST_CHECK_EQUAL( m1.size(), m2.size() );
 175   BOOST_CHECK_EQUAL( m1.get_window(), m2.get_window() );
 176   BOOST_CHECK_EQUAL( m1.get_threshold(), m2.get_threshold() );
 177   BOOST_CHECK_EQUAL( m2.get_analysis_path().string(), analysis_path.string());
 178 }
 179
 180 BOOST_AUTO_TEST_CASE( mussa_load_motif )
 181 {
 182   string data = "AAGG 1.0 1.0 0.0\n"
 183                 "GGTT 0.0 0.1 1.0\n";
 184
 185   istringstream test_istream(data);
 186
 187   Mussa m1;
 188   m1.append_sequence("AAAAGGGGTTTT");
 189   m1.append_sequence("GGGCCCCTTCCAATT");
 190   m1.load_motifs(test_istream);
 191
 192   BOOST_CHECK_EQUAL( m1.motifs().size(), 2);
 193   for (Mussa::vector_sequence_type::const_iterator seq_i = m1.sequences().begin();
 194        seq_i != m1.sequences().end();
 195        ++seq_i)
 196   {
 197     BOOST_CHECK( (*seq_i)->motifs().size() > 0 );
 198   }
 199 }
 200
 201 BOOST_AUTO_TEST_CASE( mussa_load_broken_motif )
 202 {
 203   string data = "AAGG 1.0 1.0 0.0\n"
 204                 "GGTT 0.0 0.1 1.0 1.0\n"
 205                 "ZZCTA 0.1 0.0 1.0\n";
 206
 207   istringstream test_istream(data);
 208
 209   Mussa m1;
 210   m1.append_sequence("AAAAGGGGTTTT");
 211   m1.append_sequence("GGGCCCCTTCCAATT");
 212   BOOST_CHECK_THROW(m1.load_motifs(test_istream), motif_load_error);
 213
 214   BOOST_CHECK_EQUAL( m1.motifs().size(), 0);
 215 }
 216
 217 BOOST_AUTO_TEST_CASE( mussa_named_motif )
 218 {
 219   string data = "CCAATT cat 0.1 0.2 0.3\n";
 220   istringstream test_istream(data);
 221
 222   Mussa m1;
 223   m1.append_sequence("AAAAGGGGTTTT");
 224   m1.append_sequence("GGGCCCCTTCCAATT");
 225   m1.load_motifs(test_istream);
 226
 227   std::set<Sequence> motifs = m1.motifs();
 228   BOOST_REQUIRE_EQUAL(motifs.size(), 1);
 229   BOOST_CHECK_EQUAL(motifs.begin()->get_name(), "cat");
 230 }
 231
 232 BOOST_AUTO_TEST_CASE( mussa_weirdly_spaced_named_motif )
 233 {
 234   string data = "CCAATT       cat_meow123     0.1    0.2 0.3\n";
 235   istringstream test_istream(data);
 236
 237   Mussa m1;
 238   m1.append_sequence("AAAAGGGGTTTT");
 239   m1.append_sequence("GGGCCCCTTCCAATT");
 240   m1.load_motifs(test_istream);
 241
 242   std::set<Sequence> motifs = m1.motifs();
 243   BOOST_REQUIRE_EQUAL(motifs.size(), 1);
 244   BOOST_CHECK_EQUAL(motifs.begin()->get_name(), "cat_meow123");
 245 }
 246 BOOST_AUTO_TEST_CASE( mussa_add_motif )
 247 {
 248   vector<Sequence> motifs;
 249   motifs.push_back("AAGG");
 250   vector<Color> colors;
 251   colors.push_back(Color(1.0, 0.0, 0.0));
 252
 253   Mussa m1;
 254   m1.append_sequence("AAAAGGGGTTTT");
 255   m1.append_sequence("GGGCCCCTTGGTT");
 256   m1.set_motifs(motifs, colors);
 257   int first_size = m1.motifs().size();
 258   BOOST_CHECK_EQUAL( first_size, 1 );
 259   BOOST_REQUIRE(first_size > 0);
 260   BOOST_CHECK_EQUAL(*(m1.motifs().begin()), motifs.front());
 261   // make sure that our sequences have the right number of motifs
 262   BOOST_CHECK_EQUAL(m1.sequences()[0]->motifs().size(), 1);
 263   BOOST_CHECK_EQUAL(m1.sequences()[1]->motifs().size(), 1); // because of rc
 264
 265   // verify that setting the motif clears the arrays
 266   m1.set_motifs(motifs, colors);
 267   BOOST_CHECK_EQUAL( first_size, m1.motifs().size() );
 268   // make sure that our sequences have the right number of motifs
 269   BOOST_CHECK_EQUAL(m1.sequences()[0]->motifs().size(), 1);
 270   BOOST_CHECK_EQUAL(m1.sequences()[1]->motifs().size(), 1);
 271
 272   // add a different motif
 273   motifs.clear();
 274   motifs.push_back("CCTTGG");
 275   BOOST_CHECK_EQUAL(motifs.size(), 1);
 276   m1.set_motifs(motifs, colors);
 277   BOOST_CHECK_EQUAL(m1.motifs().size(), 1);
 278   BOOST_REQUIRE(m1.motifs().size() > 0);
 279   BOOST_CHECK_EQUAL(*(m1.motifs().begin()), motifs.front());
 280   BOOST_CHECK_EQUAL(m1.sequences()[0]->motifs().size(), 0);
 281   BOOST_CHECK_EQUAL(m1.sequences()[1]->motifs().size(), 1);
 282
 283   // try a motif that doesn't exist
 284   motifs.clear();
 285   motifs.push_back("CCTTGG");
 286   BOOST_CHECK_EQUAL(motifs.size(), 1);
 287   m1.set_motifs(motifs, colors);
 288   BOOST_CHECK_EQUAL(m1.motifs().size(), 1);
 289   BOOST_CHECK_EQUAL(m1.sequences()[0]->motifs().size(), 0);
 290   BOOST_CHECK_EQUAL(m1.sequences()[1]->motifs().size(), 1);
 291
 292 }
 293
 294 static void
 295 local_align_test(const Mussa::vector_sequence_type &seqs,
 296                  const list<ConservedPath::path_type>& result,
 297                  const list<vector<bool> >& reversed)
 298 {
 299   map<char, vector <char> >  m;
 300   assign::insert(m)('A', assign::list_of('A')('T') )
 301                    ('T', assign::list_of('T')('A') )
 302                    ('G', assign::list_of('G')('C') )
 303                    ('C', assign::list_of('C')('G') );
 304   list<vector<bool> >::const_iterator rc_i = reversed.begin();
 305
 306   for(list<ConservedPath::path_type>::const_iterator base_i = result.begin();
 307       base_i != result.end();
 308       ++base_i, ++rc_i)
 309   {
 310     // since the reverse compliment flag is relative to the first sequence
 311     // the first one should always be false
 312     BOOST_CHECK_EQUAL( (*rc_i)[0], false );
 313     const int first_path_basepair_index = (*base_i)[0];
 314     const int second_path_basepair_index = (*base_i)[1];
 315     const char first_basepair = (*seqs[0])[first_path_basepair_index];
 316     const char second_basepair = (*seqs[1])[second_path_basepair_index];
 317     // get our index into our reverse compliment map m
 318     const int second_compliment_index = (*rc_i)[1];
 319     // lookup the forward or reverse compliment depending on our rc flag
 320     const char complimented_second = m[second_basepair][second_compliment_index];
 321
 322     BOOST_CHECK_EQUAL( first_basepair, complimented_second) ;
 323   }
 324 }
 325
 326
 327 BOOST_AUTO_TEST_CASE( local_alignment )
 328 {
 329   string s0("GCGCATAT");
 330   string s1("AAAAAAAT");
 331   Sequence seq1(s1);
 332
 333   Mussa analysis;
 334   analysis.append_sequence(s0);
 335   analysis.append_sequence(s1);
 336   analysis.set_threshold(3);
 337   analysis.set_window(4);
 338   analysis.analyze();
 339   NwayPaths npath = analysis.paths();
 340   list<ConservedPath::path_type> result;
 341   list<vector<bool> > reversed;
 342   list<ConservedPath>::iterator pathz_i = npath.pathz.begin();
 343
 344   list<ConservedPath> selected_paths;
 345   selected_paths.push_back(*pathz_i);
 346   analysis.createLocalAlignment(selected_paths.begin(),
 347                                 selected_paths.end(),
 348                                 result,
 349                                 reversed);
 350
 351   local_align_test(analysis.sequences(), result, reversed);
 352
 353   ++pathz_i;
 354   result.clear();
 355   reversed.clear();
 356   selected_paths.clear();
 357   selected_paths.push_back(*pathz_i);
 358   analysis.createLocalAlignment(selected_paths.begin(),
 359                                 selected_paths.end(),
 360                                 result,
 361                                 reversed);
 362   local_align_test(analysis.sequences(), result, reversed);
 363
 364
 365 }
 366
 367 BOOST_AUTO_TEST_CASE( subanalysis )
 368 {
 369   Sequence s1("AATGAAGATTTTAATGCTTTAATTTTGTTTTGTAAACTTCGAATTTCCAAAATTTGAAA");
 370   Sequence s2("AGGAGCAAGTTCGCTTCATCGAGAATTTTTAATTTTTAGTCAAATTTTCCAATGTCTGA");
 371
 372   Mussa analysis;
 373   analysis.append_sequence(s1);
 374   analysis.append_sequence(s2);
 375   analysis.set_threshold(8);
 376   analysis.set_window(8);
 377   analysis.analyze();
 378
 379   NwayPaths perfect_path = analysis.paths();
 380   int perfect_match_count = perfect_path.pathz.size();
 381
 382   Sequence sub1 = s1.subseq(2, s1.size()-4);
 383   Sequence sub2 = s2.subseq(2, s2.size()-4);
 384   Mussa subanalysis;
 385   subanalysis.append_sequence(sub1);
 386   subanalysis.append_sequence(sub2);
 387   subanalysis.set_threshold(7);
 388   subanalysis.set_window(8);
 389   subanalysis.analyze();
 390   NwayPaths one_mismatch_path = subanalysis.paths();
 391   int one_mismatch_count = one_mismatch_path.pathz.size();
 392
 393   BOOST_CHECK( perfect_match_count < one_mismatch_count );
 394 }
 395
 396 BOOST_AUTO_TEST_CASE( dirty_flag )
 397 {
 398   Mussa m;
 399   BOOST_CHECK_EQUAL(m.is_dirty(), false);
 400   m.set_name("foo");
 401   BOOST_CHECK_EQUAL(m.is_dirty(), true);
 402   m.clear();
 403   m.set_window(30);
 404   BOOST_CHECK_EQUAL(m.is_dirty(), true);
 405   m.clear();
 406   m.set_threshold(1);
 407   BOOST_CHECK_EQUAL(m.is_dirty(), true);
 408   m.clear();
 409   m.set_soft_threshold(1);
 410   BOOST_CHECK_EQUAL(m.is_dirty(), false);
 411   m.clear();
 412   m.append_sequence("AAGGCCTT");
 413   BOOST_CHECK_EQUAL(m.is_dirty(), true);
 414 }
 415