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 // ----------------------------------------
14 #include <boost/filesystem/operations.hpp>
15 #include <boost/filesystem/fstream.hpp>
16 namespace fs = boost::filesystem;
21 #include "mussa_exceptions.hpp"
22 #include "alg/mussa.hpp"
23 #include "alg/flp.hpp"
32 Mussa::Mussa(const Mussa& m)
33 : analysis_name(m.analysis_name),
35 threshold(m.threshold),
36 soft_thres(m.soft_thres),
38 win_append(m.win_append),
39 thres_append(m.thres_append),
40 motif_sequences(m.motif_sequences),
41 color_mapper(m.color_mapper)
45 // set all parameters to null state
50 ana_mode = TransitiveNway;
56 motif_sequences.clear();
60 // these 5 simple methods manually set the parameters for doing an analysis
61 // used so that the gui can take input from user and setup the analysis
62 // note - still need a set_append(bool, bool) method...
64 Mussa::set_name(string a_name)
66 analysis_name = a_name;
69 string Mussa::get_name()
77 if (the_seqs.size() > 0)
78 return the_seqs.size();
84 Mussa::set_window(int a_window)
89 int Mussa::get_window() const
95 Mussa::set_threshold(int a_threshold)
97 threshold = a_threshold;
98 //soft_thres = a_threshold;
101 int Mussa::get_threshold() const
107 Mussa::set_soft_thres(int sft_thres)
109 soft_thres = sft_thres;
112 int Mussa::get_soft_thres() const
118 Mussa::set_analysis_mode(enum analysis_modes new_ana_mode)
120 ana_mode = new_ana_mode;
123 enum Mussa::analysis_modes Mussa::get_analysis_mode() const
128 string Mussa::get_analysis_mode_name() const
133 return string("Transitive");
136 return string("Radial");
139 return string("Entropy");
142 return string("[deprecated] Recursive");
145 throw runtime_error("invalid analysis mode type");
150 const NwayPaths& Mussa::paths() const
155 //template <class IteratorT>
156 //void Mussa::createLocalAlignment(IteratorT begin, IteratorT end)
157 void Mussa::createLocalAlignment(std::list<ConservedPath>::iterator begin,
158 std::list<ConservedPath>::iterator end,
159 std::list<ConservedPath::path_type>& result,
160 std::list<std::vector<bool> >& reversed)
162 const vector<Sequence>& raw_seq = the_seqs;
163 ConservedPath::path_type aligned_path;
166 int window_length, win_i;
169 vector<bool> rc_list;
171 vector<bool> matched;
175 for(std::list<ConservedPath>::iterator pathz_i=begin; pathz_i != end; ++pathz_i)
177 ConservedPath& a_path = *pathz_i;
178 window_length = a_path.window_size;
179 // determine which parts of the path are RC relative to first species
180 rc_list = a_path.reverseComplimented();
182 // loop over each bp in the conserved region for all sequences
183 for(win_i = 0; win_i < window_length; win_i++)
185 aligned_path.clear();
186 // determine which exact base pairs match between the sequences
188 for(i2 = 0; i2 < a_path.size()-1; i2++)
190 // assume not rc as most likely, adjust below
193 // no matter the case, any RC node needs adjustments
195 rc_1 = window_length-1;
196 if (a_path[i2+1] < 0)
197 rc_2 = window_length-1;
199 x_start = (abs(a_path[i2]-rc_1+win_i));
200 x_end = (abs(a_path[i2+1]-rc_2+win_i));
203 // ugh, and xor...only want rc coloring if just one of the nodes is rc
204 // if both nodes are rc, then they are 'normal' relative to each other
205 if((rc_list[i2] || rc_list[i2+1] )&&!(rc_list[i2] && rc_list[i2+1]))
206 { //the hideous rc matching logic - not complex, but annoying
207 if(!(( (raw_seq[i2][x_start]=='A')&&(raw_seq[i2+1][x_end]=='T')) ||
208 ((raw_seq[i2][x_start]=='T')&&(raw_seq[i2+1][x_end]=='A')) ||
209 ((raw_seq[i2][x_start]=='G')&&(raw_seq[i2+1][x_end]=='C')) ||
210 ((raw_seq[i2][x_start]=='C')&&(raw_seq[i2+1][x_end]=='G'))) )
214 aligned_path.push_back(x_start);
219 if (!( (raw_seq[i2][x_start] == raw_seq[i2+1][x_end]) &&
220 (raw_seq[i2][x_start] != 'N') &&
221 (raw_seq[i2+1][x_end] != 'N') ) ) {
224 aligned_path.push_back(x_start);
228 // grab the last part of our path, assuming we matched
230 aligned_path.push_back(x_end);
232 if (aligned_path.size() > 0) {
233 result.push_back(aligned_path);
234 reversed.push_back(rc_list);
242 // takes a string and sets it as the next seq
244 Mussa::add_a_seq(string a_seq)
249 the_seqs.push_back(aSeq);
252 const vector<Sequence>&
253 Mussa::sequences() const
258 void Mussa::load_sequence(fs::path seq_file, fs::path annot_file,
259 int fasta_index, int sub_seq_start, int sub_seq_end)
262 aseq.load_fasta(seq_file, fasta_index, sub_seq_start, sub_seq_end);
263 if ( not annot_file.empty() ) {
264 aseq.load_annot(annot_file, sub_seq_start, sub_seq_end);
266 the_seqs.push_back(aseq);
270 Mussa::load_mupa_file(fs::path para_file_path)
272 fs::ifstream para_file;
273 string file_data_line;
276 int split_index, fasta_index;
277 int sub_seq_start, sub_seq_end;
278 bool seq_params, did_seq;
281 string::size_type new_index, dir_index;
286 // if file was opened, read the parameter values
287 if (fs::exists(para_file_path))
289 para_file.open(para_file_path, ios::in);
291 // what directory is the mupa file in?
292 fs::path file_path_base = para_file_path.branch_path();
294 // setup loop by getting file's first line
295 getline(para_file,file_data_line);
296 split_index = file_data_line.find(" ");
297 param = file_data_line.substr(0,split_index);
298 value = file_data_line.substr(split_index+1);
300 while (!para_file.eof())
303 if (param == "ANA_NAME")
304 analysis_name = value;
305 else if (param == "APPEND_WIN")
307 else if (param == "APPEND_THRES")
309 else if (param == "SEQUENCE_NUM")
310 ; // ignore sequence_num now
311 else if (param == "WINDOW")
312 window = atoi(value.c_str());
313 else if (param == "THRESHOLD")
314 threshold = atoi(value.c_str());
315 else if (param == "SEQUENCE")
317 fs::path seq_file = file_path_base / value;
318 //cout << "seq_file_name " << seq_files.back() << endl;
325 while ((!para_file.eof()) && seq_params)
327 getline(para_file,file_data_line);
328 split_index = file_data_line.find(" ");
329 param = file_data_line.substr(0,split_index);
330 value = file_data_line.substr(split_index+1);
332 if (param == "FASTA_INDEX")
333 fasta_index = atoi(value.c_str());
334 else if (param == "ANNOTATION")
335 annot_file = file_path_base / value;
336 else if (param == "SEQ_START")
337 sub_seq_start = atoi(value.c_str());
338 else if (param == "SEQ_END")
340 sub_seq_end = atoi(value.c_str());
342 //ignore empty lines or that start with '#'
343 else if ((param == "") || (param == "#")) {}
344 else seq_params = false;
346 load_sequence(seq_file, annot_file, fasta_index, sub_seq_start,
350 //ignore empty lines or that start with '#'
351 else if ((param == "") || (param == "#")) {}
354 clog << "Illegal/misplaced mussa parameter in file\n";
355 clog << param << "\n";
360 getline(para_file,file_data_line);
361 split_index = file_data_line.find(" ");
362 param = file_data_line.substr(0,split_index);
363 value = file_data_line.substr(split_index+1);
370 soft_thres = threshold;
371 //cout << "nway mupa: analysis_name = " << analysis_name
372 // << " window = " << window
373 // << " threshold = " << threshold << endl;
375 // no file was loaded, signal error
378 throw mussa_load_error("Config File: " + para_file_path.string() + " not found");
384 Mussa::analyze(int w, int t, enum Mussa::analysis_modes the_ana_mode, double new_ent_thres)
386 time_t t1, t2, begin, end;
387 double seqloadtime, seqcomptime, nwaytime, savetime, totaltime;
391 ana_mode = the_ana_mode;
392 ent_thres = new_ent_thres;
403 if (the_seqs.size() < 2) {
404 throw mussa_analysis_error("you need to have at least 2 sequences to "
407 //cout << "nway ana: seq_num = " << the_seqs.size() << endl;
410 seqloadtime = difftime(t2, t1);
415 seqcomptime = difftime(t2, t1);
419 the_paths.setup(window, threshold);
422 nwaytime = difftime(t2, t1);
427 savetime = difftime(t2, t1);
430 totaltime = difftime(end, begin);
433 //cout << "seqload\tseqcomp\tnway\tsave\ttotal\n";
434 //cout << seqloadtime << "\t";
435 //cout << seqcomptime << "\t";
436 //cout << nwaytime << "\t";
437 //cout << savetime << "\t";
438 //cout << totaltime << "\n";
444 vector<int> seq_lens;
445 vector<FLPs> empty_FLP_vector;
447 string save_file_string;
449 empty_FLP_vector.clear();
450 for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++)
452 all_comps.push_back(empty_FLP_vector);
453 for(vector<Sequence>::size_type i2 = 0; i2 < the_seqs.size(); i2++)
454 all_comps[i].push_back(dummy_comp);
456 for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++)
457 seq_lens.push_back(the_seqs[i].size());
459 for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++)
460 for(vector<Sequence>::size_type i2 = i+1; i2 < the_seqs.size(); i2++)
462 //cout << "seqcomping: " << i << " v. " << i2 << endl;
463 all_comps[i][i2].setup(window, threshold);
464 all_comps[i][i2].seqcomp(the_seqs[i].get_seq(), the_seqs[i2].get_seq(), false);
465 all_comps[i][i2].seqcomp(the_seqs[i].get_seq(),the_seqs[i2].rev_comp(),true);
472 vector<string> some_Seqs;
474 the_paths.set_soft_thres(soft_thres);
476 if (ana_mode == TransitiveNway) {
477 the_paths.trans_path_search(all_comps);
479 else if (ana_mode == RadialNway) {
480 the_paths.radiate_path_search(all_comps);
482 else if (ana_mode == EntropyNway)
484 //unlike other methods, entropy needs to look at the sequence at this stage
486 for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++)
488 some_Seqs.push_back(the_seqs[i].get_seq());
491 the_paths.setup_ent(ent_thres, some_Seqs); // ent analysis extra setup
492 the_paths.entropy_path_search(all_comps);
495 // old recursive transitive analysis function
496 else if (ana_mode == RecursiveNway)
497 the_paths.find_paths_r(all_comps);
499 the_paths.simple_refine();
506 fs::path flp_filepath;
507 fs::fstream save_file;
508 ostringstream append_info;
509 int dir_create_status;
511 if (not analysis_name.empty()) {
512 // not sure why, but gotta close file each time since can't pass
514 save_name = analysis_name;
516 // gotta do bit with adding win & thres if to be appended
520 append_info << "_w" << window;
521 save_name += append_info.str();
527 append_info << "_t" << threshold;
528 save_name += append_info.str();
530 fs::path save_path( save_name);
532 if (not fs::exists(save_path)) {
533 fs::create_directory(save_path);
535 // save sequence and annots to a special mussa file
536 save_file.open(save_path / (save_name+".museq"), ios::out);
537 save_file << "<Mussa_Sequence>" << endl;
539 for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++)
541 the_seqs[i].save(save_file);
544 save_file << "</Mussa_Sequence>" << endl;
547 // save nway paths to its mussa save file
548 the_paths.save(save_path / (save_name + ".muway"));
550 for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++)
551 for(vector<Sequence>::size_type i2 = i+1; i2 < the_seqs.size(); i2++)
554 append_info << "_sp_" << i << "v" << i2;
555 all_comps[i][i2].save(save_path/(save_name+append_info.str()+".flp"));
561 Mussa::save_muway(fs::path save_path)
563 the_paths.save(save_path);
567 Mussa::load(fs::path ana_file)
570 fs::path file_path_base;
571 fs::path a_file_path;
572 fs::path ana_path(ana_file);
576 ostringstream append_info;
577 vector<FLPs> empty_FLP_vector;
580 //cout << "ana_file name " << ana_file.string() << endl;
581 analysis_name = ana_path.leaf();
582 //cout << " ana_name " << analysis_name << endl;
583 file_path_base = ana_path.branch_path() / analysis_name;
584 a_file_path = file_path_base / (analysis_name + ".muway");
585 //cout << " loading museq: " << a_file_path.string() << endl;
586 the_paths.load(a_file_path);
587 // perhaps this could be more elegent, but at least this'll let
588 // us know what our threshold and window sizes were when we load a muway
589 window = the_paths.get_window();
590 threshold = the_paths.get_threshold();
591 soft_thres = threshold;
593 int seq_num = the_paths.sequence_count();
595 a_file_path = file_path_base / (analysis_name + ".museq");
597 // this is a bit of a hack due to C++ not acting like it should with files
598 for (i = 1; i <= seq_num; i++)
601 //cout << "mussa_class: loading museq frag... " << a_file_path.string() << endl;
602 tmp_seq.load_museq(a_file_path, i);
603 the_seqs.push_back(tmp_seq);
606 empty_FLP_vector.clear();
607 for(i = 0; i < seq_num; i++)
609 all_comps.push_back(empty_FLP_vector);
610 for(i2 = 0; i2 < seq_num; i2++)
611 all_comps[i].push_back(dummy_comp);
614 for(i = 0; i < seq_num; i++)
616 for(i2 = i+1; i2 < seq_num; i2++)
619 append_info << analysis_name << "_sp_" << i << "v" << i2 << ".flp";
620 //cout << append_info.str() << endl;
621 a_file_path = file_path_base / append_info.str();
622 //cout << "path " << a_file_path.string() << endl;
623 all_comps[i][i2].load(a_file_path);
624 //cout << "real size = " << all_comps[i][i2].size() << endl;
633 fs::fstream save_file;
635 save_file.open(analysis_name, ios::out);
637 for(vector<Sequence>::size_type i = 0; i < the_seqs.size(); i++)
638 save_file << the_seqs[i].get_seq() << endl;
640 save_file << window << endl;
642 //note more complex eventually since analysis_name may need to have
643 //window size, threshold and other stuff to modify it...
644 the_paths.save_old(analysis_name);
649 Mussa::load_old(char * load_file_path, int s_num)
652 string file_data_line;
653 int i, space_split_i, comma_split_i;
654 vector<int> loaded_path;
655 string node_pair, node;
659 the_paths.setup(0, 0);
660 save_file.open(load_file_path, ios::in);
662 // currently loads old mussa format
665 for(i = 0; i < seq_num; i++)
667 getline(save_file, file_data_line);
668 a_seq.set_seq(file_data_line);
669 the_seqs.push_back(a_seq);
673 getline(save_file, file_data_line);
674 window = atoi(file_data_line.c_str());
677 while (!save_file.eof())
680 getline(save_file, file_data_line);
681 if (file_data_line != "")
682 for(i = 0; i < seq_num; i++)
684 space_split_i = file_data_line.find(" ");
685 node_pair = file_data_line.substr(0,space_split_i);
686 //cout << "np= " << node_pair;
687 comma_split_i = node_pair.find(",");
688 node = node_pair.substr(comma_split_i+1);
689 //cout << "n= " << node << " ";
690 loaded_path.push_back(atoi (node.c_str()));
691 file_data_line = file_data_line.substr(space_split_i+1);
694 // FIXME: do we have any information about what the threshold should be?
695 the_paths.add_path(0, loaded_path);
699 //the_paths.save("tmp.save");
702 void Mussa::add_motifs(const vector<string>& motifs,
703 const vector<Color>& colors)
705 if (motifs.size() != colors.size()) {
706 throw mussa_error("motif and color vectors must be the same size");
709 for(size_t i = 0; i != motifs.size(); ++i)
711 motif_sequences.insert(motifs[i]);
712 color_mapper.appendInstanceColor("motif", motifs[i], colors[i]);
714 update_sequences_motifs();
717 // I mostly split the ifstream out so I can use a stringstream to test it.
718 void Mussa::load_motifs(std::istream &in)
727 in >> seq >> red >> green >> blue;
728 // if we couldn't read this line 'cause we're like at the end of the file
729 // try to exit the loop
733 seq = Sequence::motif_normalize(seq);
734 } catch(motif_normalize_error e) {
735 clog << "unable to parse " << seq << " skipping" << endl;
736 clog << e.what() << endl;
739 if (red < 0.0 or red > 1.0) {
740 clog << "invalid red value " << red << ". must be in range [0..1]"
744 if (green < 0.0 or green > 1.0) {
745 clog << "invalid green value " << green << ". must be in range [0..1]"
749 if (blue < 0.0 or blue > 1.0) {
750 clog << "invalid blue value " << blue << ". must be in range [0..1]"
754 if (motif_sequences.find(seq) == motif_sequences.end()) {
755 // sequence wasn't found
756 motif_sequences.insert(seq);
757 Color c(red, green, blue);
758 color_mapper.appendInstanceColor("motif", seq, c);
760 clog << "sequence " << seq << " was already defined skipping"
765 update_sequences_motifs();
768 void Mussa::load_motifs(fs::path filename)
771 f.open(filename, ifstream::in);
775 void Mussa::update_sequences_motifs()
777 // once we've loaded all the motifs from the file,
778 // lets attach them to the sequences
779 for(vector<Sequence>::iterator seq_i = the_seqs.begin();
780 seq_i != the_seqs.end();
783 // clear out old motifs
784 seq_i->clear_motifs();
785 // for all the motifs in our set, attach them to the current sequence
786 for(set<string>::iterator motif_i = motif_sequences.begin();
787 motif_i != motif_sequences.end();
790 seq_i->add_motif(*motif_i);
795 const set<string>& Mussa::motifs() const
797 return motif_sequences;
800 AnnotationColors& Mussa::colorMapper()