readotucommand.cpp

   1 /*
   2  *  readotu.cpp
   3  *  Mothur
   4  *
   5  *  Created by Sarah Westcott on 1/20/09.
   6  *  Copyright 2009 Schloss Lab UMASS AMherst. All rights reserved.
   7  *
   8  */
   9
  10 #include "readotucommand.h"
  11
  12 //**********************************************************************************************************************
  13 ReadOtuCommand::ReadOtuCommand(string option){
  14         try {
  15                 globaldata = GlobalData::getInstance();
  16                 abort = false;
  17                 allLines = 1;
  18
  19                 //allow user to run help
  20                 if(option == "help") { help(); abort = true; }
  21
  22                 else {
  23                         //valid paramters for this command
  24                         string Array[] =  {"list","order","shared", "line", "label","group","sabund", "rabund"};
  25                         vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
  26
  27                         parser = new OptionParser();
  28                         parser->parse(option, parameters);  delete parser;
  29
  30                         ValidParameters* validParameter = new ValidParameters();
  31
  32                         //check to make sure all parameters are valid for command
  33                         for (it = parameters.begin(); it != parameters.end(); it++) {
  34                                 if (validParameter->isValidParameter(it->first, myArray, it->second) != true) {  abort = true;  }
  35                         }
  36
  37                         globaldata->newRead();
  38
  39                         //check for required parameters
  40                         listfile = validParameter->validFile(parameters, "list", true);
  41                         if (listfile == "not open") { abort = true; }
  42                         else if (listfile == "not found") { listfile = ""; }
  43                         else {  globaldata->setListFile(listfile);  globaldata->setFormat("list");      }
  44
  45                         sabundfile = validParameter->validFile(parameters, "sabund", true);
  46                         if (sabundfile == "not open") { abort = true; }
  47                         else if (sabundfile == "not found") { sabundfile = ""; }
  48                         else {  globaldata->setSabundFile(sabundfile); globaldata->setFormat("sabund"); }
  49
  50                         rabundfile = validParameter->validFile(parameters, "rabund", true);
  51                         if (rabundfile == "not open") { abort = true; }
  52                         else if (rabundfile == "not found") { rabundfile = ""; }
  53                         else {  globaldata->setRabundFile(rabundfile);  globaldata->setFormat("rabund");}
  54
  55                         sharedfile = validParameter->validFile(parameters, "shared", true);
  56                         if (sharedfile == "not open") { abort = true; }
  57                         else if (sharedfile == "not found") { sharedfile = ""; }
  58                         else {  globaldata->setSharedFile(sharedfile); globaldata->setFormat("sharedfile");     }
  59
  60                         groupfile = validParameter->validFile(parameters, "group", true);
  61                         if (groupfile == "not open") { abort = true; }
  62                         else if (groupfile == "not found") { groupfile = ""; }
  63                         else {
  64                                 globaldata->setGroupFile(groupfile);
  65                                 groupMap = new GroupMap(groupfile);
  66                                 groupMap->readMap();
  67                         }
  68
  69                         //you are doing a list and group shared
  70                         if ((listfile != "") && (groupfile != "")) { globaldata->setFormat("shared"); }
  71
  72                         //you have not given a file
  73                         if ((listfile == "") && (sharedfile == "") && (rabundfile == "") && (sabundfile == "")) {
  74                                 cout << "You must enter either a listfile, rabundfile, sabundfile or a sharedfile with the read.otu command. " << endl; abort = true;
  75                         }
  76
  77                         //check for optional parameter and set defaults
  78                         // ...at some point should added some additional type checking...
  79                         line = validParameter->validFile(parameters, "line", false);
  80                         if (line == "not found") { line = ""; }
  81                         else {
  82                                 if(line != "all") {  splitAtDash(line, lines);  allLines = 0;  }
  83                                 else { allLines = 1;  }
  84                                 globaldata->lines = lines;
  85                         }
  86
  87                         label = validParameter->validFile(parameters, "label", false);
  88                         if (label == "not found") { label = ""; }
  89                         else {
  90                                 if(label != "all") {  splitAtDash(label, labels);  allLines = 0;  }
  91                                 else { allLines = 1;  }
  92                                 globaldata->labels = labels;
  93                         }
  94
  95                         globaldata->allLines = allLines;
  96
  97                         //make sure user did not use both the line and label parameters
  98                         if ((line != "") && (label != "")) { cout << "You cannot use both the line and label parameters at the same time. " << endl; abort = true; }
  99
 100                         orderfile = validParameter->validFile(parameters, "order", true);
 101                         if (orderfile == "not open") { abort = true; }
 102                         else if (orderfile == "not found") { orderfile = ""; }
 103                         else {  globaldata->setOrderFile(orderfile);    }
 104
 105                         delete validParameter;
 106
 107                         if (abort == false) {
 108                                 //gets whichever one of the above is set
 109                                 filename = globaldata->inputFileName;
 110                                 read = new ReadOTUFile(filename);
 111                         }
 112
 113                 }
 114
 115         }
 116         catch(exception& e) {
 117                 cout << "Standard Error: " << e.what() << " has occurred in the ReadOtuCommand class Function ReadOtuCommand. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 118                 exit(1);
 119         }
 120         catch(...) {
 121                 cout << "An unknown error has occurred in the ReadOtuCommand class function ReadOtuCommand. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 122                 exit(1);
 123         }
 124 }
 125 //**********************************************************************************************************************
 126
 127 void ReadOtuCommand::help(){
 128         try {
 129                 cout << "The read.otu command must be run before you execute a collect.single, rarefaction.single, summary.single, " << "\n";
 130                 cout << "collect.shared, rarefaction.shared or summary.shared command.   Mothur will generate a .list, .rabund and .sabund upon completion of the cluster command " << "\n";
 131                 cout << "or you may use your own. The read.otu command parameter options are list, rabund, sabund, shared, group, order, line and label." << "\n";
 132                 cout << "The read.otu command can be used in two ways.  The first is to read a list, rabund or sabund and run the collect.single, rarefaction.single or summary.single." << "\n";
 133                 cout << "For this use the read.otu command should be in the following format: read.otu(list=yourListFile, order=yourOrderFile, label=yourLabels)." << "\n";
 134                 cout << "The list, rabund or sabund parameter is required, but you may only use one of them." << "\n";
 135                 cout << "The line and label parameters are optional but you may not use both the line and label parameters at the same time." << "\n";
 136                 cout << "The label and line parameters are used to read specific lines in your input." << "\n";
 137                 cout << "The second way to use the read.otu command is to read a list and a group, or a shared so you can use the collect.shared, rarefaction.shared or summary.shared commands." << "\n";
 138                 cout << "In this case the read.otu command should be in the following format: read.otu(list=yourListFile, group=yourGroupFile, line=yourLines) or read.otu(shared=yourSharedFile).  " << "\n";
 139                 cout << "The list parameter and group paramaters or the shared paremeter is required. When using the command the second way with a list and group file read.otu command parses the .list file" << "\n";
 140                 cout << "and separates it into groups.  It outputs a .shared file containing the OTU information for each group. The read.otu command also outputs a .list file for each group. " << "\n";
 141                 cout << "Note: No spaces between parameter labels (i.e. list), '=' and parameters (i.e.yourListfile)." << "\n" << "\n";
 142
 143         }
 144         catch(exception& e) {
 145                 cout << "Standard Error: " << e.what() << " has occurred in the ReadOtuCommand class Function help. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 146                 exit(1);
 147         }
 148         catch(...) {
 149                 cout << "An unknown error has occurred in the ReadOtuCommand class function help. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 150                 exit(1);
 151         }
 152 }
 153
 154
 155
 156 //**********************************************************************************************************************
 157
 158 ReadOtuCommand::~ReadOtuCommand(){
 159         if (abort == false) {  delete read;  }
 160 }
 161
 162 //**********************************************************************************************************************
 163
 164 int ReadOtuCommand::execute(){
 165         try {
 166
 167                 if (abort == true) {    return 0;       }
 168
 169                 read->read(&*globaldata);
 170                 if (globaldata->getFormat() == "shared") {
 171                         groupMap->readMap();
 172
 173                         //if (globaldata->gGroupmap != NULL) { delete globaldata->gGroupmap;  }
 174                         globaldata->gGroupmap = groupMap;
 175                         shared = new SharedCommand();
 176                         shared->execute();
 177
 178                         parselist = new ParseListCommand();
 179                         parselist->execute();
 180
 181                         //change format to shared  to speed up commands
 182                         globaldata->setFormat("sharedfile");
 183                         globaldata->setListFile("");
 184                         globaldata->setGroupFile("");
 185                         globaldata->setSharedFile(getRootName(filename) + "shared");
 186                 }
 187                 return 0;
 188         }
 189         catch(exception& e) {
 190                 cout << "Standard Error: " << e.what() << " has occurred in the ReadOtuCommand class Function execute. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 191                 exit(1);
 192         }
 193         catch(...) {
 194                 cout << "An unknown error has occurred in the ReadOtuCommand class function execute. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 195                 exit(1);
 196         }
 197 }
 198 //**********************************************************************************************************************