chimerabellerophoncommand.cpp

   1 /*
   2  *  chimerabellerophoncommand.cpp
   3  *  Mothur
   4  *
   5  *  Created by westcott on 4/1/10.
   6  *  Copyright 2010 Schloss Lab. All rights reserved.
   7  *
   8  */
   9
  10 #include "chimerabellerophoncommand.h"
  11 #include "bellerophon.h"
  12
  13 //**********************************************************************************************************************
  14 vector<string> ChimeraBellerophonCommand::getValidParameters(){
  15         try {
  16                 string AlignArray[] =  {"fasta","filter","correction","processors","window","increment","outputdir","inputdir"};
  17                 vector<string> myArray (AlignArray, AlignArray+(sizeof(AlignArray)/sizeof(string)));
  18                 return myArray;
  19         }
  20         catch(exception& e) {
  21                 m->errorOut(e, "ChimeraBellerophonCommand", "getValidParameters");
  22                 exit(1);
  23         }
  24 }
  25 //**********************************************************************************************************************
  26 vector<string> ChimeraBellerophonCommand::getRequiredParameters(){
  27         try {
  28                 string AlignArray[] =  {"fasta"};
  29                 vector<string> myArray (AlignArray, AlignArray+(sizeof(AlignArray)/sizeof(string)));
  30                 return myArray;
  31         }
  32         catch(exception& e) {
  33                 m->errorOut(e, "ChimeraBellerophonCommand", "getRequiredParameters");
  34                 exit(1);
  35         }
  36 }
  37 //**********************************************************************************************************************
  38 vector<string> ChimeraBellerophonCommand::getRequiredFiles(){
  39         try {
  40                 vector<string> myArray;
  41                 return myArray;
  42         }
  43         catch(exception& e) {
  44                 m->errorOut(e, "ChimeraBellerophonCommand", "getRequiredFiles");
  45                 exit(1);
  46         }
  47 }
  48 //**********************************************************************************************************************
  49 ChimeraBellerophonCommand::ChimeraBellerophonCommand(){
  50         try {
  51                 //initialize outputTypes
  52                 vector<string> tempOutNames;
  53                 outputTypes["chimera"] = tempOutNames;
  54                 outputTypes["accnos"] = tempOutNames;
  55         }
  56         catch(exception& e) {
  57                 m->errorOut(e, "ChimeraBellerophonCommand", "ChimeraBellerophonCommand");
  58                 exit(1);
  59         }
  60 }
  61 //***************************************************************************************************************
  62 ChimeraBellerophonCommand::ChimeraBellerophonCommand(string option)  {
  63         try {
  64                 abort = false;
  65
  66                 //allow user to run help
  67                 if(option == "help") { help(); abort = true; }
  68
  69                 else {
  70                         //valid paramters for this command
  71                         string Array[] =  {"fasta","filter","correction","processors","window","increment","outputdir","inputdir"};
  72                         vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
  73
  74                         OptionParser parser(option);
  75                         map<string,string> parameters = parser.getParameters();
  76
  77                         ValidParameters validParameter("chimera.bellerophon");
  78                         map<string,string>::iterator it;
  79
  80                         //check to make sure all parameters are valid for command
  81                         for (it = parameters.begin(); it != parameters.end(); it++) {
  82                                 if (validParameter.isValidParameter(it->first, myArray, it->second) != true) {  abort = true;  }
  83                         }
  84
  85                         //initialize outputTypes
  86                         vector<string> tempOutNames;
  87                         outputTypes["chimera"] = tempOutNames;
  88                         outputTypes["accnos"] = tempOutNames;
  89
  90                         //if the user changes the input directory command factory will send this info to us in the output parameter
  91                         string inputDir = validParameter.validFile(parameters, "inputdir", false);
  92                         if (inputDir == "not found"){   inputDir = "";          }
  93
  94                         fastafile = validParameter.validFile(parameters, "fasta", false);
  95                         if (fastafile == "not found") { fastafile = ""; m->mothurOut("fasta is a required parameter for the chimera.bellerophon command."); m->mothurOutEndLine(); abort = true;  }
  96                         else {
  97                                 m->splitAtDash(fastafile, fastaFileNames);
  98
  99                                 //go through files and make sure they are good, if not, then disregard them
 100                                 for (int i = 0; i < fastaFileNames.size(); i++) {
 101                                         if (inputDir != "") {
 102                                                 string path = m->hasPath(fastaFileNames[i]);
 103                                                 //if the user has not given a path then, add inputdir. else leave path alone.
 104                                                 if (path == "") {       fastaFileNames[i] = inputDir + fastaFileNames[i];               }
 105                                         }
 106
 107                                         int ableToOpen;
 108                                         ifstream in;
 109
 110                                         ableToOpen = m->openInputFile(fastaFileNames[i], in, "noerror");
 111
 112                                         //if you can't open it, try default location
 113                                         if (ableToOpen == 1) {
 114                                                 if (m->getDefaultPath() != "") { //default path is set
 115                                                         string tryPath = m->getDefaultPath() + m->getSimpleName(fastaFileNames[i]);
 116                                                         m->mothurOut("Unable to open " + fastaFileNames[i] + ". Trying default " + tryPath); m->mothurOutEndLine();
 117                                                         ableToOpen = m->openInputFile(tryPath, in, "noerror");
 118                                                         fastaFileNames[i] = tryPath;
 119                                                 }
 120                                         }
 121
 122                                         //if you can't open it, try default location
 123                                         if (ableToOpen == 1) {
 124                                                 if (m->getOutputDir() != "") { //default path is set
 125                                                         string tryPath = m->getOutputDir() + m->getSimpleName(fastaFileNames[i]);
 126                                                         m->mothurOut("Unable to open " + fastaFileNames[i] + ". Trying output directory " + tryPath); m->mothurOutEndLine();
 127                                                         ableToOpen = m->openInputFile(tryPath, in, "noerror");
 128                                                         fastaFileNames[i] = tryPath;
 129                                                 }
 130                                         }
 131
 132                                         in.close();
 133
 134                                         if (ableToOpen == 1) {
 135                                                 m->mothurOut("Unable to open " + fastaFileNames[i] + ". It will be disregarded."); m->mothurOutEndLine();
 136                                                 //erase from file list
 137                                                 fastaFileNames.erase(fastaFileNames.begin()+i);
 138                                                 i--;
 139                                         }
 140
 141                                 }
 142
 143                                 //make sure there is at least one valid file left
 144                                 if (fastaFileNames.size() == 0) { m->mothurOut("no valid files."); m->mothurOutEndLine(); abort = true; }
 145                         }
 146
 147                         //if the user changes the output directory command factory will send this info to us in the output parameter
 148                         outputDir = validParameter.validFile(parameters, "outputdir", false);           if (outputDir == "not found"){  outputDir = ""; }
 149
 150                         string temp;
 151                         temp = validParameter.validFile(parameters, "filter", false);                   if (temp == "not found") { temp = "F"; }
 152                         filter = m->isTrue(temp);
 153
 154                         temp = validParameter.validFile(parameters, "correction", false);               if (temp == "not found") { temp = "T"; }
 155                         correction = m->isTrue(temp);
 156
 157                         temp = validParameter.validFile(parameters, "processors", false);               if (temp == "not found") { temp = "1"; }
 158                         convert(temp, processors);
 159
 160                         temp = validParameter.validFile(parameters, "window", false);                   if (temp == "not found") { temp = "0"; }
 161                         convert(temp, window);
 162
 163                         temp = validParameter.validFile(parameters, "increment", false);                if (temp == "not found") { temp = "25"; }
 164                         convert(temp, increment);
 165                 }
 166         }
 167         catch(exception& e) {
 168                 m->errorOut(e, "ChimeraBellerophonCommand", "ChimeraBellerophonCommand");
 169                 exit(1);
 170         }
 171 }
 172 //**********************************************************************************************************************
 173
 174 void ChimeraBellerophonCommand::help(){
 175         try {
 176                 m->mothurOut("The chimera.bellerophon command reads a fastafile and creates list of potentially chimeric sequences.\n");
 177                 m->mothurOut("The chimera.bellerophon command parameters are fasta, filter, correction, processors, window, increment. The fasta parameter is required.\n");
 178                 m->mothurOut("The fasta parameter is required.  You may enter multiple fasta files by separating their names with dashes. ie. fasta=abrecovery.fasta-amzon.fasta \n");
 179                 m->mothurOut("The filter parameter allows you to specify if you would like to apply a vertical and 50% soft filter, default=false. \n");
 180                 m->mothurOut("The correction parameter allows you to put more emphasis on the distance between highly similar sequences and less emphasis on the differences between remote homologs, default=true.\n");
 181                 m->mothurOut("The processors parameter allows you to specify how many processors you would like to use.  The default is 1. \n");
 182                 #ifdef USE_MPI
 183                 m->mothurOut("When using MPI, the processors parameter is set to the number of MPI processes running. \n");
 184                 #endif
 185                 m->mothurOut("The window parameter allows you to specify the window size for searching for chimeras, default is 1/4 sequence length. \n");
 186                 m->mothurOut("The increment parameter allows you to specify how far you move each window while finding chimeric sequences, default is 25.\n");
 187                 m->mothurOut("chimera.bellerophon(fasta=yourFastaFile, filter=yourFilter, correction=yourCorrection, processors=yourProcessors) \n");
 188                 m->mothurOut("Example: chimera.bellerophon(fasta=AD.align, filter=True, correction=true, window=200) \n");
 189                 m->mothurOut("Note: No spaces between parameter labels (i.e. fasta), '=' and parameters (i.e.yourFastaFile).\n\n");
 190         }
 191         catch(exception& e) {
 192                 m->errorOut(e, "ChimeraBellerophonCommand", "help");
 193                 exit(1);
 194         }
 195 }
 196
 197 //***************************************************************************************************************
 198
 199 ChimeraBellerophonCommand::~ChimeraBellerophonCommand(){        /*      do nothing      */      }
 200
 201 //***************************************************************************************************************
 202
 203 int ChimeraBellerophonCommand::execute(){
 204         try{
 205
 206                 if (abort == true) { return 0; }
 207
 208                 for (int i = 0; i < fastaFileNames.size(); i++) {
 209
 210                         m->mothurOut("Checking sequences from " + fastaFileNames[i] + " ..." ); m->mothurOutEndLine();
 211
 212                         int start = time(NULL);
 213
 214                         chimera = new Bellerophon(fastaFileNames[i], filter, correction, window, increment, processors, outputDir);
 215
 216                         if (outputDir == "") { outputDir = m->hasPath(fastaFileNames[i]);  }//if user entered a file with a path then preserve it
 217                         string outputFileName = outputDir + m->getRootName(m->getSimpleName(fastaFileNames[i])) +  "bellerophon.chimeras";
 218                         string accnosFileName = outputDir + m->getRootName(m->getSimpleName(fastaFileNames[i])) + "bellerophon.accnos";
 219
 220                         chimera->getChimeras();
 221
 222                         if (m->control_pressed) { delete chimera; for (int i = 0; i < outputNames.size(); i++) {        remove(outputNames[i].c_str()); } outputTypes.clear(); return 0;        }
 223
 224                 #ifdef USE_MPI
 225                         MPI_File outMPI;
 226                         MPI_File outMPIAccnos;
 227
 228                         int outMode=MPI_MODE_CREATE|MPI_MODE_WRONLY;
 229
 230                         char outFilename[1024];
 231                         strcpy(outFilename, accnosFileName.c_str());
 232
 233                         char FileName[1024];
 234                         strcpy(FileName, outputFileName.c_str());
 235
 236                         MPI_File_open(MPI_COMM_WORLD, FileName, outMode, MPI_INFO_NULL, &outMPI);  //comm, filename, mode, info, filepointer
 237                         MPI_File_open(MPI_COMM_WORLD, outFilename, outMode, MPI_INFO_NULL, &outMPIAccnos);
 238
 239                         numSeqs = chimera->print(outMPI, outMPIAccnos);
 240
 241                         MPI_File_close(&outMPI);
 242                         MPI_File_close(&outMPIAccnos);
 243
 244                 #else
 245
 246                         ofstream out;
 247                         m->openOutputFile(outputFileName, out);
 248
 249                         ofstream out2;
 250                         m->openOutputFile(accnosFileName, out2);
 251
 252                         numSeqs = chimera->print(out, out2);
 253                         out.close();
 254                         out2.close();
 255
 256                 #endif
 257
 258                         if (m->control_pressed) { remove(accnosFileName.c_str()); remove(outputFileName.c_str()); for (int i = 0; i < outputNames.size(); i++) {        remove(outputNames[i].c_str()); } outputTypes.clear(); delete chimera;  return 0;       }
 259
 260                         m->mothurOutEndLine(); m->mothurOut("It took " + toString(time(NULL) - start) + " secs to check " + toString(numSeqs) + " sequences."); m->mothurOutEndLine(); m->mothurOutEndLine();
 261
 262                         outputNames.push_back(outputFileName);  outputTypes["chimera"].push_back(outputFileName);
 263                         outputNames.push_back(accnosFileName);  outputTypes["accnos"].push_back(accnosFileName);
 264
 265                         delete chimera;
 266                 }
 267
 268                 m->mothurOutEndLine();
 269                 m->mothurOut("Output File Names: "); m->mothurOutEndLine();
 270                 for (int i = 0; i < outputNames.size(); i++) {  m->mothurOut(outputNames[i]); m->mothurOutEndLine();    }
 271                 m->mothurOutEndLine();
 272
 273                 return 0;
 274
 275         }
 276         catch(exception& e) {
 277                 m->errorOut(e, "ChimeraBellerophonCommand", "execute");
 278                 exit(1);
 279         }
 280 }
 281 //**********************************************************************************************************************
 282