alg/mussa.hpp

   1 #ifndef _MUSSA_CLASS_H_
   2 #define _MUSSA_CLASS_H_
   3 //  This file is part of the Mussa source distribution.
   4 //  http://mussa.caltech.edu/
   5 //  Contact author: Tristan  De Buysscher, tristan@caltech.edu
   6
   7 // This program and all associated source code files are Copyright (C) 2005
   8 // the California Institute of Technology, Pasadena, CA, 91125 USA.  It is
   9 // under the GNU Public License; please see the included LICENSE.txt
  10 // file for more information, or contact Tristan directly.
  11
  12
  13 //                        ----------------------------------------
  14 //                          ---------- mussa_class.hh -----------
  15 //                        ----------------------------------------
  16 #include <boost/filesystem/path.hpp>
  17
  18 #include <list>
  19 #include <string>
  20 #include <vector>
  21 #include <set>
  22 #include <istream>
  23
  24 #include "alg/annotation_colors.hpp"
  25 #include "alg/nway_paths.hpp"
  26 #include "alg/sequence.hpp"
  27
  28 std::string int_to_str(int an_int);
  29
  30 class Mussa
  31 {
  32   friend class ConnWindow;
  33   public:
  34     enum analysis_modes { TransitiveNway, RadialNway, EntropyNway,
  35                           RecursiveNway };
  36
  37     Mussa();
  38     Mussa(const Mussa &);
  39
  40     void save();
  41     //! save the nway comparison
  42     void save_muway(boost::filesystem::path save_path);
  43     //! load a saved analysis directory
  44     void load(boost::filesystem::path ana_path);
  45
  46     //! clear parameters and initialize data lists
  47     void clear();
  48
  49     //! set parameters from a file - 'mupa' ~ mussa parameters
  50     void load_mupa_file(std::string para_file_path) { load_mupa_file(boost::filesystem::path(para_file_path));}
  51     void load_mupa_file(boost::filesystem::path para_file_path);
  52
  53     // set parameters individually (eg from user input into gui classes)
  54     //! set analysis name
  55     void set_name(std::string a_name);
  56     //! return name for this analysis
  57     std::string get_name();
  58
  59     //! return number of sequences in this analyzis
  60     /*! this returns either the_seqs.size() or seq_files.size()
  61      *  depending on which has data loaded in
  62      *  (silly delayed loading of sequence data)
  63      */
  64     int size() const;
  65     //! set number of bases for this window size
  66     void set_window(int a_window);
  67     //! get number of bases for the sliding window
  68     int get_window() const;
  69     //! set number of bases that must match for a window to be saved
  70     void set_threshold(int a_threshold);
  71     //! get number of bases that must match for a window to be saved
  72     int get_threshold() const;
  73     void set_soft_thres(int sft_thres);
  74     int get_soft_thres() const;
  75
  76     void set_analysis_mode(enum analysis_modes new_ana_mode);
  77     enum analysis_modes get_analysis_mode() const;
  78     //! return a string name for an analysis mode
  79     std::string get_analysis_mode_name() const;
  80
  81     //! return the refined paths found by the nway analysis.
  82     const NwayPaths& paths() const;
  83
  84     //! run seqcomp and the nway filtering algorithm.
  85     /*!analyze will run seqcomp and then the nway algorithm
  86      * on whatever sequences have been loaded into this mussa instance.
  87      * w & t are for command line override functionality, set to 0 to ignore
  88      * \throws mussa_analysis_error
  89      */
  90     void analyze(int w=0, int t=0,
  91                  enum analysis_modes ana_mode=TransitiveNway,
  92                  double ent_thres=0.0);
  93     /*! Run the nway filtering algorithm,
  94      *  this might be used when changing the soft threshhold?
  95      */
  96     void nway();
  97
  98     //! appends a string sequence to the list of the_seqs
  99     void add_a_seq(std::string a_seq);
 100     //! Load a sequence from a fasta file and any annotations
 101     /*! \param[in] seq_file the full path to the fasta file
 102      *  \param[in] annot_file the full path to an annotation file,
 103      *             if is an empty string, we won't bother loading anything
 104      *  \param[in] fasta_index specify which sequence in a multisequence fasta
 105      *             file
 106      *  \param[in] sub_seq_start starting slice index to select a subsequence
 107      *             use 0 start from the beginning.
 108      *  \param[in] sub_seq_end ending slice index to select a subsequence
 109      *             use 0 to go to the end.
 110      */
 111     void load_sequence(boost::filesystem::path seq_file,
 112                        boost::filesystem::path annot_file,
 113                        int fasta_index, int sub_seq_start=0, int sub_seq_end=0);
 114     //! allow examining the sequences we have loaded
 115     const std::vector<Sequence>& sequences() const;
 116
 117     // deprecated - support bridge for python version of mussa
 118     // these save & load from the old file format
 119     void save_old();
 120     void load_old(char * load_file_path, int s_num);
 121
 122     // manage motif lists
 123     //! add vector of motifs and colors to our motif collection
 124     /*! this depends on sets and color maps being unique
 125      *  (aka if you add the same item more than once it doesn't
 126      *  increase the size of the data structure
 127      */
 128     void add_motifs(const std::vector<std::string>& motifs,
 129                     const std::vector<Color>& colors);
 130     //! load motifs from an ifstream
 131     /*! The file should look something like
 132      *  <sequence> <red> <green> <blue>
 133      *  where sequence is a string of IUPAC symbols
 134      *  and red,green,blue are a white space separated list of floats
 135      *  in the range [0.0, 1.0]
 136      */
 137     void load_motifs(std::istream &);
 138     //! load a list of motifs from a file named filename
 139     void load_motifs(boost::filesystem::path filename);
 140     //! return our motifs;
 141     const std::set<std::string>& motifs() const;
 142
 143     //! return color mapper
 144     AnnotationColors& colorMapper();
 145
 146   private:
 147     //! push motifs to our attached sequences
 148     void update_sequences_motifs();
 149
 150     // Private variables
 151     // parameters needed for a mussa analysis
 152     //! name of this analysis. (will also be used when saving an analysis)
 153     std::string analysis_name;
 154     //! how many base pairs to include in a sliding window
 155     int window;
 156     //! how many base pairs need to match order to record a window as conserved
 157     int threshold;
 158     int soft_thres;
 159     //! which nway comparison algorithm to use.
 160     enum analysis_modes ana_mode;
 161     double ent_thres;
 162     //! should we append _w<window_size> to the saved analysis
 163     bool win_append;
 164     //! should we append _t<threshold> to the saved analysis
 165     bool thres_append;
 166
 167     //! sequence data
 168     std::vector<Sequence> the_seqs;
 169     //! the seqcomp data
 170     std::vector<std::vector<FLPs> > all_comps;
 171     //! N-way data, ie the mussa results
 172     NwayPaths the_paths;
 173
 174     //! motif list
 175     std::set<std::string> motif_sequences;
 176     //! color manager
 177     AnnotationColors color_mapper;
 178
 179     // Private methods
 180     //! loads sequence and annotations from fasta and annotation file
 181     void seqcomp();
 182
 183 };
 184 #endif