alg/test/test_sequence.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
   6 #include <list>
   7 #include <iostream>
   8 #include <sstream>
   9
  10 #include <boost/archive/text_oarchive.hpp>
  11 #include <boost/archive/text_iarchive.hpp>
  12
  13 #include "alg/sequence.hpp"
  14 #include "mussa_exceptions.hpp"
  15
  16 using namespace std;
  17
  18 //! when we try to load a missing file, do we get an error?
  19 BOOST_AUTO_TEST_CASE( sequence_load_exception )
  20 {
  21   Sequence s;
  22   // there should be errors when we try to load something that doesn't exist
  23   BOOST_CHECK_THROW( s.load_fasta("alkejralk", 1, 0, 0), mussa_load_error);
  24   BOOST_CHECK_THROW( s.load_annot("alkejralk", 0, 0), mussa_load_error);
  25 }
  26
  27 BOOST_AUTO_TEST_CASE( sequence_eol_conventions )
  28 {
  29   string header(">Header");
  30   string line1("AAAAGGGGCCCCTTTTT");
  31   string line2("AAAAGGGGCCCCTTTTT");
  32   int seq_len = line1.size() + line2.size();
  33
  34   stringstream cr;
  35   cr << header << "\015" << line1 << "\015" << line2 << "\015";
  36   Sequence seq_cr;
  37   seq_cr.load_fasta(cr);
  38
  39   stringstream crlf;
  40   crlf << header << "\015\012" << line1 << "\015\012" << line2 << "\015\012";
  41   Sequence seq_crlf;
  42   seq_crlf.load_fasta(crlf);
  43
  44   stringstream lf;
  45   lf << header << "\012" << line1 << "\012" << line2 << "\012";
  46   Sequence seq_lf;
  47   seq_lf.load_fasta(lf);
  48
  49   BOOST_CHECK_EQUAL(seq_cr.size(),   seq_len);
  50   BOOST_CHECK_EQUAL(seq_crlf.size(), seq_len);
  51   BOOST_CHECK_EQUAL(seq_cr.size(),   seq_len);
  52 }
  53
  54
  55 //! Do simple operations work correctly?
  56 BOOST_AUTO_TEST_CASE( sequence_filter )
  57 {
  58   const char *core_seq = "AATTGGCC";
  59   Sequence s1(core_seq);
  60   BOOST_CHECK_EQUAL(s1, core_seq);
  61
  62   Sequence s2("aattggcc");
  63   BOOST_CHECK_EQUAL(s2, "AATTGGCC");
  64   BOOST_CHECK_EQUAL(s2.rev_comp(), "GGCCAATT");
  65   BOOST_CHECK_EQUAL(s2.size(), s2.size());
  66   BOOST_CHECK_EQUAL(s2.c_str(), core_seq);
  67
  68   Sequence s3("asdfg");
  69   BOOST_CHECK_EQUAL(s3, "ANNNG");
  70   BOOST_CHECK_EQUAL(s3.subseq(0,2), "AN");
  71
  72   s3.set_filtered_sequence("AAGGCCTT", 0, 2);
  73   BOOST_CHECK_EQUAL(s3, "AA");
  74   s3.set_filtered_sequence("AAGGCCTT", 2, 2);
  75   BOOST_CHECK_EQUAL( s3, "GG");
  76   s3.set_filtered_sequence("AAGGCCTT", 4);
  77   BOOST_CHECK_EQUAL( s3, "CCTT");
  78
  79   s3.clear();
  80   BOOST_CHECK_EQUAL(s3, "");
  81
  82   s3 = "AAGGFF";
  83   BOOST_CHECK_EQUAL(s3, "AAGGNN");
  84 }
  85
  86 BOOST_AUTO_TEST_CASE( subseq_names )
  87 {
  88   Sequence s1("AAGGCCTT");
  89   s1.set_species("species");
  90   s1.set_fasta_header("a fasta header");
  91   Sequence s2 = s1.subseq(2,2);
  92   BOOST_CHECK_EQUAL(s2, "GG");
  93   BOOST_CHECK_EQUAL(s2.get_species(), s1.get_species());
  94   BOOST_CHECK_EQUAL(s2.get_fasta_header(), s1.get_fasta_header());
  95 }
  96
  97 //! Can we load data from a file
  98 BOOST_AUTO_TEST_CASE( sequence_load )
  99 {
 100   fs::path seq_path(fs::path(EXAMPLE_DIR)/ "seq" );
 101   seq_path /=  "human_mck_pro.fa";
 102   Sequence s;
 103   s.load_fasta(seq_path);
 104   BOOST_CHECK_EQUAL(s.subseq(0, 5), "GGATC"); // first few chars of fasta file
 105   BOOST_CHECK_EQUAL(s.subseq(2, 3), "ATC");
 106   BOOST_CHECK_EQUAL(s.get_fasta_header(), "gi|180579|gb|M21487.1|HUMCKMM1 Human "
 107                                     "muscle creatine kinase gene (CKMM), "
 108                                     "5' flank");
 109 }
 110
 111 BOOST_AUTO_TEST_CASE( annotation_load )
 112 {
 113   string annot_data = "human\n"
 114                       "0 10 name   type\n"
 115                       "10 20 myf7\n"
 116                       "20 30 myod\n"
 117                       "50\t55 anothername\n"
 118                       "60 50 backward\n"
 119                       ">ident3 asdf\n"
 120                       "GCT\n"
 121                       "gCTn\n"
 122                       "75\t90\tname2\ttype2\n"
 123                       "100 120 name-asdf type!@#$%\n"
 124                       ;
 125   string s(100, 'A');
 126   s += "GCTGCTAATT";
 127   Sequence seq(s);
 128
 129   //istringstream annot_stream(annot_data);
 130   seq.parse_annot(annot_data, 0, 0);
 131   std::list<annot> annots_list = seq.annotations();
 132   std::vector<annot> annots(annots_list.begin(), annots_list.end());
 133   BOOST_REQUIRE_EQUAL( annots.size(), 8);
 134   BOOST_CHECK_EQUAL( annots[0].begin, 0 );
 135   BOOST_CHECK_EQUAL( annots[0].end, 10 );
 136   BOOST_CHECK_EQUAL( annots[0].type, "type");
 137   BOOST_CHECK_EQUAL( annots[0].name, "name");
 138   BOOST_CHECK_EQUAL( annots[1].name, "myf7");
 139   BOOST_CHECK_EQUAL( annots[2].name, "myod");
 140   BOOST_CHECK_EQUAL( annots[3].name, "anothername");
 141   BOOST_CHECK_EQUAL( annots[4].name, "backward");
 142   BOOST_CHECK_EQUAL( annots[5].name, "name2");
 143   BOOST_CHECK_EQUAL( annots[5].end, 90);
 144   BOOST_CHECK_EQUAL( annots[6].begin, 100);
 145   BOOST_CHECK_EQUAL( annots[6].end, 120);
 146   BOOST_CHECK_EQUAL( annots[6].name, "name-asdf");
 147   BOOST_CHECK_EQUAL( annots[6].type, "type!@#$%");
 148   // sequence defined annotations will always be after the
 149   // absolute positions
 150   BOOST_CHECK_EQUAL( annots[7].name, "ident3 asdf");
 151   BOOST_CHECK_EQUAL( annots[7].begin, 100);
 152
 153   //BOOST_CHECK_EQUAL( annots
 154 }
 155
 156 BOOST_AUTO_TEST_CASE( annotation_load_no_species_name )
 157 {
 158   string annot_data = "0 10 name   type\n"
 159                       "10 20 myf7\n"
 160                       "20 30 myod\n"
 161                       "50\t55 anothername\n"
 162                       "60 50 backward\n"
 163                       ">ident3 asdf\n"
 164                       "GCT\n"
 165                       "gCTn\n"
 166                       "75\t90\tname2\ttype2\n"
 167                       "100 120 name-asdf type!@#$%\n"
 168                       ;
 169   string s(100, 'A');
 170   s += "GCTGCTAATT";
 171   Sequence seq(s);
 172
 173   //istringstream annot_stream(annot_data);
 174   seq.parse_annot(annot_data, 0, 0);
 175   std::list<annot> annots_list = seq.annotations();
 176   std::vector<annot> annots(annots_list.begin(), annots_list.end());
 177   BOOST_REQUIRE_EQUAL( annots.size(), 8);
 178   BOOST_CHECK_EQUAL( annots[0].begin, 0 );
 179   BOOST_CHECK_EQUAL( annots[0].end, 10 );
 180   BOOST_CHECK_EQUAL( annots[0].type, "type");
 181 }
 182
 183 // ticket:83 when you try to load a sequence from a file that doesn't
 184 // have fasta headers it crashes.
 185 BOOST_AUTO_TEST_CASE( sequence_past_end )
 186 {
 187   fs::path seq_path(fs::path(EXAMPLE_DIR)/ "seq" );
 188   seq_path /=  "misformated_seq.fa";
 189   Sequence s;
 190   BOOST_CHECK_THROW( s.load_fasta(seq_path), mussa_load_error );
 191 }
 192
 193 BOOST_AUTO_TEST_CASE ( sequence_empty )
 194 {
 195   Sequence s;
 196   BOOST_CHECK_EQUAL( s.empty(), true );
 197   s = "AAAGGG";
 198   BOOST_CHECK_EQUAL( s.empty(), false );
 199 }
 200
 201 BOOST_AUTO_TEST_CASE ( sequence_iterators )
 202 {
 203   std::string seq_string = "AAGGCCTTNNTATA";
 204   Sequence s(seq_string);
 205   const Sequence cs(s);
 206   std::string::size_type count = 0;
 207
 208   std::string::iterator str_itor;
 209   Sequence::iterator s_itor;
 210   Sequence::const_iterator cs_itor;
 211
 212   for( str_itor = seq_string.begin(),
 213        s_itor   = s.begin(),
 214        cs_itor  = cs.begin();
 215        str_itor != seq_string.end() and
 216        s_itor   != s.end() and
 217        cs_itor  != cs.end();
 218        ++str_itor, ++s_itor, ++cs_itor, ++count)
 219   {
 220     BOOST_CHECK_EQUAL ( *str_itor, *s_itor );
 221     BOOST_CHECK_EQUAL ( *s_itor, *cs_itor );
 222     BOOST_CHECK_EQUAL ( *cs_itor, *str_itor );
 223   }
 224   BOOST_CHECK_EQUAL( seq_string.size(), count );
 225   BOOST_CHECK_EQUAL( s.size(), count );
 226   BOOST_CHECK_EQUAL( cs.size(), count );
 227 }
 228
 229 BOOST_AUTO_TEST_CASE( sequence_motifs )
 230 {
 231   string m("AAAA");
 232   string bogus("AATTGGAA");
 233   Sequence s1("AAAAGGGGCCCCTTTT");
 234
 235   list<motif>::const_iterator motif_i = s1.motifs().begin();
 236   list<motif>::const_iterator motif_end = s1.motifs().end();
 237
 238   // do our iterators work?
 239   BOOST_CHECK( motif_i == s1.motifs().begin() );
 240   BOOST_CHECK( motif_end == s1.motifs().end() );
 241   BOOST_CHECK( motif_i == motif_end );
 242
 243   // this shouldn't show up
 244   s1.add_motif(bogus);
 245   BOOST_CHECK( s1.motifs().begin() == s1.motifs().end() );
 246   BOOST_CHECK_EQUAL( s1.motifs().size(), 0 );
 247
 248   s1.add_motif(m);
 249   BOOST_CHECK( s1.motifs().begin() != s1.motifs().end() );
 250   BOOST_CHECK_EQUAL( s1.motifs().size(), 2 );
 251
 252   for(motif_i = s1.motifs().begin();
 253       motif_i != s1.motifs().end();
 254       ++motif_i)
 255   {
 256     BOOST_CHECK_EQUAL( motif_i->type, "motif" );
 257     BOOST_CHECK_EQUAL( motif_i->name, m);
 258     BOOST_CHECK_EQUAL( motif_i->sequence, m);
 259   }
 260
 261   s1.clear_motifs();
 262   BOOST_CHECK( s1.motifs().begin() == s1.motifs().end() );
 263
 264   /* FIXME: enable this when i find a way of passing storing the motif name
 265   // does our annotation travel?
 266   Sequence motif_seq(m);
 267   motif_seq.set_fasta_header("hi");
 268   s1.add_motif(motif_seq);
 269
 270   BOOST_CHECK_EQUAL(s1.motifs().size(), 2);
 271   for(motif_i = s1.motifs().begin();
 272       motif_i != s1.motifs().end();
 273       ++motif_i)
 274   {
 275     BOOST_CHECK_EQUAL( motif_i->type, "motif" );
 276     BOOST_CHECK_EQUAL( motif_i->name, "hi");
 277     BOOST_CHECK_EQUAL( motif_i->sequence, m);
 278   }
 279   */
 280 }
 281
 282 BOOST_AUTO_TEST_CASE( annot_test )
 283 {
 284   annot a(0, 10, "test", "thing");
 285
 286   BOOST_CHECK_EQUAL( a.begin, 0 );
 287   BOOST_CHECK_EQUAL( a.end,   10 );
 288   BOOST_CHECK_EQUAL( a.type,  "test" );
 289   BOOST_CHECK_EQUAL( a.name,  "thing" );
 290
 291   motif m(10, "AAGGCC");
 292   BOOST_CHECK_EQUAL( m.begin, 10 );
 293   BOOST_CHECK_EQUAL( m.type, "motif" );
 294   BOOST_CHECK_EQUAL( m.name, "AAGGCC" );
 295   BOOST_CHECK_EQUAL( m.end,  10+6 );
 296 }
 297
 298 BOOST_AUTO_TEST_CASE( annotate_from_sequence )
 299 {
 300   string s("CCGCCCCCCATCATCGCGGCTCTCCGAGAGTCCCGCGCCCCACTCCCGGC"
 301            "ACCCACCTGACCGCGGGCGGCTCCGGCCCCGCTTCGCCCCACTGCGATCA"
 302            "GTCGCGTCCCGCAGGCCAGGCACGCCCCGCCGCTCCCGCTGCGCCGGGCG"
 303            "TCTGGGACCTCGGGCGGCTCCTCCGAGGGGCGGGGCAGCCGGGAGCCACG"
 304            "CCCCCGCAGGTGAGCCGGCCACGCCCACCGCCCGTGGGAAGTTCAGCCTC"
 305            "GGGGCTCCAGCCCCGCGGGAATGGCAGAACTTCGCACGCGGAACTGGTAA"
 306            "CCTCCAGGACACCTCGAATCAGGGTGATTGTAGCGCAGGGGCCTTGGCCA"
 307            "AGCTAAAACTTTGGAAACTTTAGATCCCAGACAGGTGGCTTTCTTGCAGT");
 308   string gc("GCCCCC");
 309   string gga("GGACACCTC");
 310   Sequence seq(s);
 311
 312   std::list<Sequence> query_list;
 313   std::list<string> string_list;
 314   query_list.push_back(Sequence(gc));
 315   string_list.push_back(gc);
 316   query_list.push_back(Sequence(gga));
 317   string_list.push_back(gga);
 318
 319   BOOST_CHECK_EQUAL( seq.annotations().size(), 0 );
 320   seq.find_sequences(query_list.begin(), query_list.end());
 321
 322   int count = 0;
 323   for(list<string>::iterator string_i = string_list.begin();
 324       string_i != string_list.end();
 325       ++string_i)
 326   {
 327     string::size_type pos=0;
 328     while(pos != string::npos) {
 329       pos = s.find(*string_i, pos);
 330       if (pos != string::npos) {
 331         ++count;
 332         ++pos;
 333       }
 334     }
 335   }
 336   BOOST_CHECK_EQUAL(seq.annotations().size(), count);
 337 }
 338
 339 BOOST_AUTO_TEST_CASE( subseq_annotation_test )
 340 {
 341   string s("CCGCCCCCCATCATCGCGGCTCTCCGAGAGTCCCGCGCCCCACTCCCGGC"
 342            "ACCCACCTGACCGCGGGCGGCTCCGGCCCCGCTTCGCCCCACTGCGATCA"
 343            "GTCGCGTCCCGCAGGCCAGGCACGCCCCGCCGCTCCCGCTGCGCCGGGCG"
 344            "TCTGGGACCTCGGGCGGCTCCTCCGAGGGGCGGGGCAGCCGGGAGCCACG"
 345            "CCCCCGCAGGTGAGCCGGCCACGCCCACCGCCCGTGGGAAGTTCAGCCTC"
 346            "GGGGCTCCAGCCCCGCGGGAATGGCAGAACTTCGCACGCGGAACTGGTAA"
 347            "CCTCCAGGACACCTCGAATCAGGGTGATTGTAGCGCAGGGGCCTTGGCCA"
 348            "AGCTAAAACTTTGGAAACTTTAGATCCCAGACAGGTGGCTTTCTTGCAGT");
 349   Sequence seq(s);
 350
 351
 352   seq.add_annotation(annot(0, 10, "0-10", "0-10"));
 353   seq.add_annotation(annot(10, 20, "10-20", "10-20"));
 354   seq.add_annotation(annot(0, 20, "0-20", "0-20"));
 355   seq.add_annotation(annot(8, 12, "8-12", "8-12"));
 356   seq.add_annotation(annot(100, 5000, "100-5000", "100-5000"));
 357
 358   Sequence subseq = seq.subseq(5, 10);
 359   const list<annot> annots = subseq.annotations();
 360   // generate some ground truth
 361   list<annot> correct;
 362   correct.push_back(annot(0, 5, "0-10",  "0-10"));
 363   correct.push_back(annot(5,10, "10-20", "10-20"));
 364   correct.push_back(annot(0,10, "0-20",  "0-20"));
 365   correct.push_back(annot(3, 7, "8-12",  "8-12"));
 366   BOOST_REQUIRE_EQUAL( annots.size(), correct.size() );
 367
 368   list<annot>::iterator correct_i = correct.begin();
 369   list<annot>::const_iterator annot_i = annots.begin();
 370   for(; annot_i != annots.end(); ++annot_i, ++correct_i)
 371   {
 372     BOOST_CHECK( *annot_i == *correct_i );
 373   }
 374 }
 375
 376 BOOST_AUTO_TEST_CASE( motif_annotation_update )
 377 {
 378   string s("CCGTCCCCCATCATCGCGGCTCTCCGAGAGTCCCGCGCCCCACTCCCGGC"
 379            "ACCCACCTGACCGCGGGCGGCTCCGGCCCCGCTTCGCCCCACTGCGATCA"
 380            "GTCGCGTCCCGCAGGCCAGGCACGCCCCGCCGCTCCCGCTGCGCCGGGCG"
 381            "TCTGGGACCTCGGGCGGCTCCTCCGAGGGGCGGGGCAGCCGGGAGCCACG"
 382            "CCCCCGCAGGTGAGCCGGCCACGCCCACCGCCCGTGGGAAGTTCAGCCTC"
 383            "GGGGCTCCAGCCCCGCGGGAATGGCAGAACTTCGCACGCGGAACTGGTAA"
 384            "CCTCCAGGACACCTCGAATCAGGGTGATTGTAGCGCAGGGGCCTTGGCCA"
 385            "AGCTAAAACTTTGGAAACTTTAGATCCCAGACAGGTGGCTTTCTTGCAGT");
 386   Sequence seq(s);
 387
 388   // starting conditions
 389   BOOST_CHECK_EQUAL(seq.annotations().size(), 0);
 390   BOOST_CHECK_EQUAL(seq.motifs().size(), 0);
 391   seq.add_annotation(annot(0, 10, "0-10", "0-10"));
 392   seq.add_annotation(annot(10, 20, "10-20", "10-20"));
 393   seq.add_annotation(annot(0, 20, "0-20", "0-20"));
 394   BOOST_CHECK_EQUAL(seq.annotations().size(), 3);
 395   BOOST_CHECK_EQUAL(seq.motifs().size(), 0);
 396   seq.add_motif("CCGTCCC");
 397   BOOST_CHECK_EQUAL(seq.annotations().size(), 3);
 398   BOOST_CHECK_EQUAL(seq.motifs().size(), 1);
 399   seq.clear_motifs();
 400   BOOST_CHECK_EQUAL(seq.annotations().size(), 3);
 401   BOOST_CHECK_EQUAL(seq.motifs().size(), 0);
 402 }
 403
 404 BOOST_AUTO_TEST_CASE( out_operator )
 405 {
 406   string s("AAGGCCTT");
 407   Sequence seq(s);
 408
 409   ostringstream buf;
 410   buf << s;
 411   BOOST_CHECK_EQUAL( s, buf.str() );
 412 }
 413
 414 BOOST_AUTO_TEST_CASE( get_name )
 415 {
 416   Sequence seq("AAGGCCTT");
 417
 418   BOOST_CHECK_EQUAL( seq.get_name(), "" );
 419   seq.set_species("hooman"); // anyone remember tradewars?
 420   BOOST_CHECK_EQUAL( seq.get_name(), "hooman");
 421   seq.set_fasta_header("fasta human");
 422   BOOST_CHECK_EQUAL( seq.get_name(), "fasta human");
 423 }
 424
 425 BOOST_AUTO_TEST_CASE( serialize_simple )
 426 {
 427   std::string seq_string = "AAGGCCTT";
 428   Sequence seq(seq_string);
 429
 430   std::ostringstream oss;
 431   // allocate/deallocate serialization components
 432   {
 433     boost::archive::text_oarchive oarchive(oss);
 434     const Sequence& const_seq(seq);
 435     BOOST_CHECK_EQUAL(seq, const_seq);
 436     oarchive << const_seq;
 437   }
 438
 439   Sequence seq_loaded;
 440   {
 441     std::istringstream iss(oss.str());
 442     boost::archive::text_iarchive iarchive(iss);
 443     iarchive >> seq_loaded;
 444   }
 445 }