1 // This file is part of the Mussa source distribution.
2 // http://mussa.caltech.edu/
3 // Contact author: Tristan De Buysscher, tristan@caltech.edu
5 // This program and all associated source code files are Copyright (C) 2005
6 // the California Institute of Technology, Pasadena, CA, 91125 USA. It is
7 // under the GNU Public License; please see the included LICENSE.txt
8 // file for more information, or contact Tristan directly.
11 // ----------------------------------------
12 // ---------- mussa_class.cc -----------
13 // ----------------------------------------
15 #include <boost/filesystem/path.hpp>
16 #include <boost/filesystem/operations.hpp>
17 #include <boost/filesystem/fstream.hpp>
18 namespace fs = boost::filesystem;
20 #include <boost/spirit/core.hpp>
21 #include <boost/spirit/actor/push_back_actor.hpp>
22 #include <boost/spirit/iterator/file_iterator.hpp>
23 #include <boost/spirit/utility/chset.hpp>
24 namespace spirit = boost::spirit;
29 #include "mussa_exceptions.hpp"
30 #include "alg/mussa.hpp"
31 #include "alg/flp.hpp"
37 : color_mapper(new AnnotationColors)
40 connect(&the_paths, SIGNAL(progress(const std::string&, int, int)),
41 this, SIGNAL(progress(const std::string&, int, int)));
44 Mussa::Mussa(const Mussa& m)
45 : analysis_name(m.analysis_name),
47 threshold(m.threshold),
48 soft_thres(m.soft_thres),
50 win_append(m.win_append),
51 thres_append(m.thres_append),
52 motif_sequences(m.motif_sequences),
53 color_mapper(m.color_mapper),
54 analysis_path(m.analysis_path),
57 connect(&the_paths, SIGNAL(progress(const std::string&, int, int)),
58 this, SIGNAL(progress(const std::string&, int, int)));
61 boost::filesystem::path Mussa::get_analysis_path() const
66 void Mussa::set_analysis_path(boost::filesystem::path pathname)
68 analysis_path = pathname;
71 // set all parameters to null state
76 ana_mode = TransitiveNway;
82 motif_sequences.clear();
83 if(color_mapper) color_mapper->clear();
86 analysis_path = fs::path();
90 bool Mussa::is_dirty() const
95 bool Mussa::empty() const
97 return the_seqs.empty();
101 // these 5 simple methods manually set the parameters for doing an analysis
102 // used so that the gui can take input from user and setup the analysis
103 // note - still need a set_append(bool, bool) method...
105 Mussa::set_name(string a_name)
107 analysis_name = a_name;
111 string Mussa::get_name() const
113 return analysis_name;
116 string Mussa::get_title() const
118 fs::path analysis_path = get_analysis_path();
119 if (not analysis_path.empty()) {
120 return analysis_path.native_file_string();
121 } else if (get_name().size() > 0) {
124 return std::string("Unnamed");
131 if (the_seqs.size() > 0)
132 return the_seqs.size();
138 Mussa::set_window(int a_window)
144 int Mussa::get_window() const
150 Mussa::set_threshold(int a_threshold)
152 threshold = a_threshold;
154 if (a_threshold > soft_thres) {
155 soft_thres = a_threshold;
159 int Mussa::get_threshold() const
165 Mussa::set_soft_threshold(int new_threshold)
167 if (new_threshold < threshold) {
168 soft_thres = threshold;
169 } else if (new_threshold > window) {
172 soft_thres = new_threshold;
176 int Mussa::get_soft_threshold() const
182 Mussa::set_analysis_mode(enum analysis_modes new_ana_mode)
184 ana_mode = new_ana_mode;
188 enum Mussa::analysis_modes Mussa::get_analysis_mode() const
193 string Mussa::get_analysis_mode_name() const
198 return string("Transitive");
201 return string("Radial");
204 return string("Entropy");
207 return string("[deprecated] Recursive");
210 throw runtime_error("invalid analysis mode type");
215 const NwayPaths& Mussa::paths() const
220 //template <class IteratorT>
221 //void Mussa::createLocalAlignment(IteratorT begin, IteratorT end)
222 void Mussa::createLocalAlignment(std::list<ConservedPath>::iterator begin,
223 std::list<ConservedPath>::iterator end,
224 std::list<ConservedPath::path_type>& result,
225 std::list<std::vector<bool> >& reversed)
227 const vector_sequence_type& raw_seq = the_seqs;
228 ConservedPath::path_type aligned_path;
231 int window_length, win_i;
234 vector<bool> rc_list;
236 vector<bool> matched;
240 for(std::list<ConservedPath>::iterator pathz_i=begin; pathz_i != end; ++pathz_i)
242 ConservedPath& a_path = *pathz_i;
243 window_length = a_path.window_size;
244 // determine which parts of the path are RC relative to first species
245 rc_list = a_path.reverseComplimented();
247 // loop over each bp in the conserved region for all sequences
248 for(win_i = 0; win_i < window_length; win_i++)
250 aligned_path.clear();
251 // determine which exact base pairs match between the sequences
253 for(i2 = 0; i2 < a_path.size()-1; i2++)
255 // assume not rc as most likely, adjust below
258 // no matter the case, any RC node needs adjustments
260 rc_1 = window_length-1;
261 if (a_path[i2+1] < 0)
262 rc_2 = window_length-1;
264 x_start = (abs(a_path[i2]-rc_1+win_i));
265 x_end = (abs(a_path[i2+1]-rc_2+win_i));
267 boost::shared_ptr<Sequence> cur(raw_seq[i2]) ;
268 boost::shared_ptr<Sequence> next(raw_seq[i2+1]);
270 // ugh, and xor...only want rc coloring if just one of the nodes is rc
271 // if both nodes are rc, then they are 'normal' relative to each other
272 if((rc_list[i2] || rc_list[i2+1] )&&!(rc_list[i2] && rc_list[i2+1]))
273 { //the hideous rc matching logic - not complex, but annoying
274 if(!(( ((*cur)[x_start]=='A')&&((*next)[x_end]=='T')) ||
275 (((*cur)[x_start]=='T')&&((*next)[x_end]=='A')) ||
276 (((*cur)[x_start]=='G')&&((*next)[x_end]=='C')) ||
277 (((*cur)[x_start]=='C')&&((*next)[x_end]=='G'))) )
281 aligned_path.push_back(x_start);
286 if (!( ((*cur)[x_start] == (*next)[x_end]) &&
287 ((*cur)[x_start] != 'N') && ((*next)[x_end] != 'N') ) ) {
290 aligned_path.push_back(x_start);
294 // grab the last part of our path, assuming we matched
296 aligned_path.push_back(x_end);
298 if (aligned_path.size() == a_path.size()) {
299 result.push_back(aligned_path);
300 reversed.push_back(rc_list);
308 void Mussa::append_sequence(const Sequence& a_seq)
310 boost::shared_ptr<Sequence> seq_copy(new Sequence(a_seq));
311 the_seqs.push_back(seq_copy);
315 void Mussa::append_sequence(boost::shared_ptr<Sequence> a_seq)
317 the_seqs.push_back(a_seq);
322 const vector<boost::shared_ptr<Sequence> >&
323 Mussa::sequences() const
328 void Mussa::load_sequence(fs::path seq_file, fs::path annot_file,
329 int fasta_index, int sub_seq_start, int sub_seq_end,
332 boost::shared_ptr<Sequence> aseq(new Sequence);
333 aseq->load_fasta(seq_file, fasta_index, sub_seq_start, sub_seq_end);
334 if ( not annot_file.empty() ) {
335 aseq->load_annot(annot_file, sub_seq_start, sub_seq_end);
337 if (name != 0 and name->size() > 0 ) {
338 aseq->set_species(*name);
340 the_seqs.push_back(aseq);
345 Mussa::load_mupa_file(fs::path para_file_path)
347 fs::ifstream para_file;
348 string file_data_line;
351 int split_index, fasta_index;
352 int sub_seq_start, sub_seq_end;
353 bool seq_params, did_seq;
356 string::size_type new_index, dir_index;
361 // if file was opened, read the parameter values
362 if (not fs::exists(para_file_path))
364 throw mussa_load_error("Config File: " + para_file_path.string() + " not found");
365 } else if (fs::is_directory(para_file_path)) {
366 throw mussa_load_error("Config File: " + para_file_path.string() + " is a directory.");
367 } else if (fs::is_empty(para_file_path)) {
368 throw mussa_load_error("Config File: " + para_file_path.string() + " is empty");
370 para_file.open(para_file_path, ios::in);
372 // what directory is the mupa file in?
373 fs::path file_path_base = para_file_path.branch_path();
375 // setup loop by getting file's first line
376 getline(para_file,file_data_line);
377 split_index = file_data_line.find(" ");
378 param = file_data_line.substr(0,split_index);
379 value = file_data_line.substr(split_index+1);
384 if (param == "ANA_NAME")
385 analysis_name = value;
386 else if (param == "APPEND_WIN")
388 else if (param == "APPEND_THRES")
390 else if (param == "SEQUENCE_NUM")
391 ; // ignore sequence_num now
392 else if (param == "WINDOW")
393 window = atoi(value.c_str());
394 else if (param == "THRESHOLD")
395 threshold = atoi(value.c_str());
396 else if (param == "SEQUENCE")
398 fs::path seq_file = file_path_base / value;
399 //cout << "seq_file_name " << seq_files.back() << endl;
406 while (para_file && seq_params)
408 getline(para_file,file_data_line);
409 split_index = file_data_line.find(" ");
410 param = file_data_line.substr(0,split_index);
411 value = file_data_line.substr(split_index+1);
413 if (param == "FASTA_INDEX")
414 fasta_index = atoi(value.c_str());
415 else if (param == "ANNOTATION")
416 annot_file = file_path_base / value;
417 else if (param == "SEQ_START")
418 sub_seq_start = atoi(value.c_str());
419 else if (param == "SEQ_END")
421 sub_seq_end = atoi(value.c_str());
423 //ignore empty lines or that start with '#'
424 else if ((param == "") || (param == "#")) {}
425 else seq_params = false;
427 load_sequence(seq_file, annot_file, fasta_index, sub_seq_start,
431 //ignore empty lines or that start with '#'
432 else if ((param == "") || (param == "#")) {}
435 clog << "Illegal/misplaced mussa parameter in file\n";
436 clog << param << "\n";
441 getline(para_file,file_data_line);
442 split_index = file_data_line.find(" ");
443 param = file_data_line.substr(0,split_index);
444 value = file_data_line.substr(split_index+1);
451 soft_thres = threshold;
452 //cout << "nway mupa: analysis_name = " << analysis_name
453 // << " window = " << window
454 // << " threshold = " << threshold << endl;
456 // no file was loaded, signal error
464 if (the_seqs.size() < 2) {
465 throw mussa_analysis_error("you need to have at least 2 sequences to "
468 //cout << "nway ana: seq_num = " << the_seqs.size() << endl;
471 the_paths.setup(window, threshold);
478 vector<int> seq_lens;
479 vector<FLPs> empty_FLP_vector;
481 string save_file_string;
483 empty_FLP_vector.clear();
484 for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++)
486 all_comps.push_back(empty_FLP_vector);
487 for(vector<Sequence>::size_type i2 = 0; i2 < the_seqs.size(); i2++)
488 all_comps[i].push_back(dummy_comp);
490 for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++) {
491 seq_lens.push_back(the_seqs[i]->size());
493 int seqcomps_done = 0;
494 int seqcomps_todo = (the_seqs.size() * (the_seqs.size()-1)) / 2;
495 emit progress("seqcomp", seqcomps_done, seqcomps_todo);
497 for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++)
498 for(vector<Sequence>::size_type i2 = i+1; i2 < the_seqs.size(); i2++)
500 //cout << "seqcomping: " << i << " v. " << i2 << endl;
501 all_comps[i][i2].setup(window, threshold);
502 all_comps[i][i2].seqcomp(*the_seqs[i], *the_seqs[i2], false);
503 all_comps[i][i2].seqcomp(*the_seqs[i], the_seqs[i2]->rev_comp(),true);
505 emit progress("seqcomp", seqcomps_done, seqcomps_todo);
513 the_paths.set_soft_threshold(soft_thres);
515 if (ana_mode == TransitiveNway) {
516 the_paths.trans_path_search(all_comps);
518 else if (ana_mode == RadialNway) {
519 the_paths.radiate_path_search(all_comps);
521 else if (ana_mode == EntropyNway)
523 vector<Sequence> some_Seqs;
524 //unlike other methods, entropy needs to look at the sequence at this stage
526 for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++)
528 some_Seqs.push_back(*the_seqs[i]);
531 the_paths.setup_ent(ent_thres, some_Seqs); // ent analysis extra setup
532 the_paths.entropy_path_search(all_comps);
535 // old recursive transitive analysis function
536 else if (ana_mode == RecursiveNway)
537 the_paths.find_paths_r(all_comps);
539 the_paths.simple_refine();
543 Mussa::save(fs::path save_path)
545 fs::path flp_filepath;
546 fs::fstream save_file;
547 ostringstream append_info;
548 int dir_create_status;
550 if (save_path.empty()) {
551 if (not analysis_path.empty()) {
552 save_path = analysis_path;
553 } else if (not analysis_name.empty()) {
554 std::string save_name = analysis_name;
555 // gotta do bit with adding win & thres if to be appended
558 append_info << "_w" << window;
559 save_name += append_info.str();
564 append_info << "_t" << threshold;
565 save_name += append_info.str();
567 save_path = save_name;
569 throw mussa_save_error("Need filename or analysis name to save");
573 if (not fs::exists(save_path)) {
574 fs::create_directory(save_path);
576 // save sequence and annots to a special mussa file
577 save_file.open(save_path / (save_path.leaf()+".museq"), ios::out);
578 save_file << "<Mussa_Sequence>" << endl;
580 for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++)
582 the_seqs[i]->save(save_file);
585 save_file << "</Mussa_Sequence>" << endl;
588 // if we have any motifs, save them.
589 if (motif_sequences.size()) {
590 save_motifs(save_path/(save_path.leaf()+".mtl"));
593 // save nway paths to its mussa save file
594 the_paths.save(save_path / (save_path.leaf()+ ".muway"));
596 for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++) {
597 for(vector<Sequence>::size_type i2 = i+1; i2 < the_seqs.size(); i2++)
600 append_info << "_sp_" << i << "v" << i2;
601 all_comps[i][i2].save(save_path/(save_path.leaf()+append_info.str()+".flp"));
606 analysis_path = save_path;
610 Mussa::save_muway(fs::path save_path)
612 the_paths.save(save_path);
616 Mussa::load(fs::path ana_file)
619 fs::path file_path_base;
620 fs::path a_file_path;
621 fs::path ana_path(ana_file);
624 ostringstream append_info;
625 vector<FLPs> empty_FLP_vector;
628 analysis_path = ana_file;
629 analysis_name = ana_path.leaf();
630 file_path_base = ana_path.branch_path() / analysis_name;
631 a_file_path = file_path_base / (analysis_name + ".muway");
632 the_paths.load(a_file_path);
633 // perhaps this could be more elegent, but at least this'll let
634 // us know what our threshold and window sizes were when we load a muway
635 window = the_paths.get_window();
636 threshold = the_paths.get_threshold();
637 soft_thres = threshold;
639 int seq_num = the_paths.sequence_count();
641 a_file_path = file_path_base / (analysis_name + ".museq");
643 // this is a bit of a hack due to C++ not acting like it should with files
644 for (i = 1; i <= seq_num; i++)
646 boost::shared_ptr<Sequence> tmp_seq(new Sequence);
647 tmp_seq->load_museq(a_file_path, i);
648 the_seqs.push_back(tmp_seq);
651 fs::path motif_file = file_path_base / (analysis_name + ".mtl");
652 if (fs::exists(motif_file)) {
653 load_motifs(motif_file);
655 empty_FLP_vector.clear();
656 for(i = 0; i < seq_num; i++)
658 all_comps.push_back(empty_FLP_vector);
659 for(i2 = 0; i2 < seq_num; i2++)
660 all_comps[i].push_back(dummy_comp);
663 for(i = 0; i < seq_num; i++)
665 for(i2 = i+1; i2 < seq_num; i2++)
668 append_info << analysis_name << "_sp_" << i << "v" << i2 << ".flp";
669 //clog << append_info.str() << endl;
670 a_file_path = file_path_base / append_info.str();
671 //clog << "path " << a_file_path.string() << endl;
672 all_comps[i][i2].load(a_file_path);
673 //clog << "real size = " << all_comps[i][i2].size() << endl;
682 fs::fstream save_file;
684 save_file.open(analysis_name, ios::out);
686 for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++)
687 save_file << *(the_seqs[i]) << endl;
689 save_file << window << endl;
691 //note more complex eventually since analysis_name may need to have
692 //window size, threshold and other stuff to modify it...
693 the_paths.save_old(analysis_name);
698 Mussa::load_old(char * load_file_path, int s_num)
701 string file_data_line;
702 int i, space_split_i, comma_split_i;
703 vector<int> loaded_path;
704 string node_pair, node;
708 the_paths.setup(0, 0);
709 save_file.open(load_file_path, ios::in);
711 // currently loads old mussa format
714 for(i = 0; i < seq_num; i++)
716 getline(save_file, file_data_line);
717 boost::shared_ptr<Sequence> a_seq(new Sequence(file_data_line));
718 the_seqs.push_back(a_seq);
722 getline(save_file, file_data_line);
723 window = atoi(file_data_line.c_str());
726 while (!save_file.eof())
729 getline(save_file, file_data_line);
730 if (file_data_line != "")
731 for(i = 0; i < seq_num; i++)
733 space_split_i = file_data_line.find(" ");
734 node_pair = file_data_line.substr(0,space_split_i);
735 //cout << "np= " << node_pair;
736 comma_split_i = node_pair.find(",");
737 node = node_pair.substr(comma_split_i+1);
738 //cout << "n= " << node << " ";
739 loaded_path.push_back(atoi (node.c_str()));
740 file_data_line = file_data_line.substr(space_split_i+1);
743 // FIXME: do we have any information about what the threshold should be?
744 the_paths.add_path(0, loaded_path);
748 //the_paths.save("tmp.save");
751 void Mussa::add_motif(const Sequence& motif, const Color& color)
753 motif_sequences.insert(motif);
754 color_mapper->appendInstanceColor("motif", motif.get_sequence(), color);
757 void Mussa::set_motifs(const vector<Sequence>& motifs,
758 const vector<Color>& colors)
760 if (motifs.size() != colors.size()) {
761 throw mussa_error("motif and color vectors must be the same size");
764 motif_sequences.clear();
765 for(size_t i = 0; i != motifs.size(); ++i)
767 add_motif(motifs[i], colors[i]);
769 update_sequences_motifs();
772 // Helper functor to append created motifs to our Mussa analysis
773 struct push_back_motif {
774 Mussa::motif_set& motifs;
775 boost::shared_ptr<AnnotationColors> color_mapper;
776 std::string& seq_string;
784 push_back_motif(Mussa::motif_set& motifs_,
785 boost::shared_ptr<AnnotationColors> color_mapper_,
788 float &red_, float &green_, float &blue_, float &alpha_,
791 color_mapper(color_mapper_),
802 void operator()(std::string::const_iterator,
803 std::string::const_iterator) const
805 Sequence seq(seq_string, Sequence::nucleic_alphabet);
806 // shouldn't we have a better field than "fasta header" and speices?
807 seq.set_fasta_header(name);
808 // we need to clear the name in case the next motif doesn't have one.
810 // be nice if glsequence was a subclass of sequence so we could
811 // just attach colors directly to the motif.
812 Color c(red, green, blue, alpha);
813 color_mapper->appendInstanceColor("motif", seq.c_str(), c);
820 void Mussa::load_motifs(fs::path filename)
823 f.open(filename, ifstream::in);
827 // I mostly split the ifstream out so I can use a stringstream to test it.
828 void Mussa::load_motifs(std::istream &in)
831 const char *alphabet = Alphabet::nucleic_alphabet.c_str();
840 // slurp our data into a string
841 std::streamsize bytes_read = 1;
842 while (in.good() and bytes_read) {
843 const std::streamsize bufsiz=512;
845 bytes_read = in.readsome(buf, bufsiz);
846 data.append(buf, buf+bytes_read);
849 bool ok = spirit::parse(data.begin(), data.end(),
853 (+spirit::chset<>(alphabet))[spirit::assign_a(seq)] >>
858 // names can either be letter followed by non-space characters
859 (spirit::alpha_p >> *spirit::graph_p)[spirit::assign_a(name)]
861 // or a quoted string
864 (+(~spirit::ch_p('"')))[spirit::assign_a(name)] >>
867 ) >> +spirit::space_p
869 spirit::real_p[spirit::assign_a(red)] >> +spirit::space_p >>
870 spirit::real_p[spirit::assign_a(green)] >> +spirit::space_p >>
871 spirit::real_p[spirit::assign_a(blue)] >> +spirit::space_p >>
872 !(spirit::real_p[spirit::assign_a(alpha)] >> +spirit::space_p)
873 )[push_back_motif(motif_sequences, color_mapper, seq, name, red, green, blue, alpha, parsed)]
877 msg << "Error parsing motif #" << parsed;
878 // erase our potentially broken motif list
879 motif_sequences.clear();
880 throw motif_load_error(msg.str());
882 update_sequences_motifs();
885 void Mussa::save_motifs(fs::path filename)
887 fs::ofstream out_stream;
888 out_stream.open(filename, ofstream::out);
889 save_motifs(out_stream);
892 void Mussa::save_motifs(std::ostream& out)
894 for(motif_set::iterator motif_i = motif_sequences.begin();
895 motif_i != motif_sequences.end();
898 out << motif_i->get_sequence() << " ";
899 if (motif_i->get_name().size() > 0) {
900 out << "\"" << motif_i->get_name() << "\" ";
902 out << color_mapper->lookup("motif", motif_i->get_sequence());
907 void Mussa::update_sequences_motifs()
909 // once we've loaded all the motifs from the file,
910 // lets attach them to the sequences
911 for(vector<boost::shared_ptr<Sequence> >::iterator seq_i = the_seqs.begin();
912 seq_i != the_seqs.end();
915 // clear out old motifs
916 (*seq_i)->clear_motifs();
917 // for all the motifs in our set, attach them to the current sequence
918 for(set<Sequence>::iterator motif_i = motif_sequences.begin();
919 motif_i != motif_sequences.end();
922 (*seq_i)->add_motif(*motif_i);
927 const set<Sequence>& Mussa::motifs() const
929 return motif_sequences;
932 boost::shared_ptr<AnnotationColors> Mussa::colorMapper()