1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
|
/*
* phylotypecommand.cpp
* Mothur
*
* Created by westcott on 11/20/09.
* Copyright 2009 Schloss Lab. All rights reserved.
*
*/
#include "phylotypecommand.h"
#include "phylotree.h"
#include "listvector.hpp"
#include "rabundvector.hpp"
#include "sabundvector.hpp"
//**********************************************************************************************************************
vector<string> PhylotypeCommand::setParameters(){
try {
CommandParameter ptaxonomy("taxonomy", "InputTypes", "", "", "none", "none", "none","list-rabund-sabund",false,true,true); parameters.push_back(ptaxonomy);
CommandParameter pname("name", "InputTypes", "", "", "NameCount", "none", "ColumnName","rabund-sabund",false,false,true); parameters.push_back(pname);
CommandParameter pcount("count", "InputTypes", "", "", "NameCount", "none", "none","",false,false,true); parameters.push_back(pcount);
CommandParameter pcutoff("cutoff", "Number", "", "-1", "", "", "","",false,false,true); parameters.push_back(pcutoff);
CommandParameter plabel("label", "String", "", "", "", "", "","",false,false); parameters.push_back(plabel);
CommandParameter pinputdir("inputdir", "String", "", "", "", "", "","",false,false); parameters.push_back(pinputdir);
CommandParameter poutputdir("outputdir", "String", "", "", "", "", "","",false,false); parameters.push_back(poutputdir);
vector<string> myArray;
for (int i = 0; i < parameters.size(); i++) { myArray.push_back(parameters[i].name); }
return myArray;
}
catch(exception& e) {
m->errorOut(e, "PhylotypeCommand", "setParameters");
exit(1);
}
}
//**********************************************************************************************************************
string PhylotypeCommand::getHelpString(){
try {
string helpString = "";
helpString += "The phylotype command reads a taxonomy file and outputs a .list, .rabund and .sabund file. \n";
helpString += "The phylotype command parameter options are taxonomy, name, count, cutoff and label. The taxonomy parameter is required.\n";
helpString += "The cutoff parameter allows you to specify the level you want to stop at. The default is the highest level in your taxonomy file. \n";
helpString += "For example: taxonomy = Bacteria;Bacteroidetes-Chlorobi;Bacteroidetes; - cutoff=2, would truncate the taxonomy to Bacteria;Bacteroidetes-Chlorobi; \n";
helpString += "For the cutoff parameter levels count up from the root of the phylotree. This enables you to look at the grouping down to a specific resolution, say the genus level.\n";
helpString += "The label parameter allows you to specify which level you would like, and are separated by dashes. The default all levels in your taxonomy file. \n";
helpString += "For the label parameter, levels count down from the root to keep the output similar to mothur's other commands which report information from finer resolution to coarser resolutions.\n";
helpString += "The phylotype command should be in the following format: \n";
helpString += "phylotype(taxonomy=yourTaxonomyFile, cutoff=yourCutoff, label=yourLabels) \n";
helpString += "Eaxample: phylotype(taxonomy=amazon.taxonomy, cutoff=5, label=1-3-5).\n";
return helpString;
}
catch(exception& e) {
m->errorOut(e, "PhylotypeCommand", "getHelpString");
exit(1);
}
}
//**********************************************************************************************************************
string PhylotypeCommand::getOutputPattern(string type) {
try {
string pattern = "";
if (type == "list") { pattern = "[filename],[clustertag],list-[filename],[clustertag],[tag2],list"; }
else if (type == "rabund") { pattern = "[filename],[clustertag],rabund"; }
else if (type == "sabund") { pattern = "[filename],[clustertag],sabund"; }
else { m->mothurOut("[ERROR]: No definition for type " + type + " output pattern.\n"); m->control_pressed = true; }
return pattern;
}
catch(exception& e) {
m->errorOut(e, "PhylotypeCommand", "getOutputPattern");
exit(1);
}
}
//**********************************************************************************************************************
PhylotypeCommand::PhylotypeCommand(){
try {
abort = true; calledHelp = true;
setParameters();
vector<string> tempOutNames;
outputTypes["list"] = tempOutNames;
outputTypes["sabund"] = tempOutNames;
outputTypes["rabund"] = tempOutNames;
}
catch(exception& e) {
m->errorOut(e, "PhylotypeCommand", "PhylotypeCommand");
exit(1);
}
}
/**********************************************************************************************************************/
PhylotypeCommand::PhylotypeCommand(string option) {
try {
abort = false; calledHelp = false;
//allow user to run help
if(option == "help") { help(); abort = true; calledHelp = true; }
else if(option == "citation") { citation(); abort = true; calledHelp = true;}
else {
vector<string> myArray = setParameters();
OptionParser parser(option);
map<string, string> parameters = parser.getParameters();
ValidParameters validParameter;
map<string, string>::iterator it;
//check to make sure all parameters are valid for command
for (it = parameters.begin(); it != parameters.end(); it++) {
if (validParameter.isValidParameter(it->first, myArray, it->second) != true) { abort = true; }
}
//initialize outputTypes
vector<string> tempOutNames;
outputTypes["list"] = tempOutNames;
outputTypes["sabund"] = tempOutNames;
outputTypes["rabund"] = tempOutNames;
//if the user changes the input directory command factory will send this info to us in the output parameter
string inputDir = validParameter.validFile(parameters, "inputdir", false);
if (inputDir == "not found"){ inputDir = ""; }
else {
string path;
it = parameters.find("taxonomy");
//user has given a template file
if(it != parameters.end()){
path = m->hasPath(it->second);
//if the user has not given a path then, add inputdir. else leave path alone.
if (path == "") { parameters["taxonomy"] = inputDir + it->second; }
}
it = parameters.find("name");
//user has given a template file
if(it != parameters.end()){
path = m->hasPath(it->second);
//if the user has not given a path then, add inputdir. else leave path alone.
if (path == "") { parameters["name"] = inputDir + it->second; }
}
it = parameters.find("count");
//user has given a template file
if(it != parameters.end()){
path = m->hasPath(it->second);
//if the user has not given a path then, add inputdir. else leave path alone.
if (path == "") { parameters["count"] = inputDir + it->second; }
}
}
taxonomyFileName = validParameter.validFile(parameters, "taxonomy", true);
if (taxonomyFileName == "not found") {
taxonomyFileName = m->getTaxonomyFile();
if (taxonomyFileName != "") { m->mothurOut("Using " + taxonomyFileName + " as input file for the taxonomy parameter."); m->mothurOutEndLine(); }
else {
m->mothurOut("No valid current files. taxonomy is a required parameter."); m->mothurOutEndLine();
abort = true;
}
}else if (taxonomyFileName == "not open") { taxonomyFileName = ""; abort = true; }
else { m->setTaxonomyFile(taxonomyFileName); }
namefile = validParameter.validFile(parameters, "name", true);
if (namefile == "not open") { namefile = ""; abort = true; }
else if (namefile == "not found") { namefile = ""; }
else { readNamesFile(); m->setNameFile(namefile); }
countfile = validParameter.validFile(parameters, "count", true);
if (countfile == "not open") { abort = true; countfile = ""; }
else if (countfile == "not found") { countfile = ""; }
else { m->setCountTableFile(countfile); }
//if the user changes the output directory command factory will send this info to us in the output parameter
outputDir = validParameter.validFile(parameters, "outputdir", false); if (outputDir == "not found"){
outputDir = "";
outputDir += m->hasPath(taxonomyFileName); //if user entered a file with a path then preserve it
}
if ((countfile != "") && (namefile != "")) { m->mothurOut("You must enter ONLY ONE of the following: count or name."); m->mothurOutEndLine(); abort = true; }
string temp = validParameter.validFile(parameters, "cutoff", false);
if (temp == "not found") { temp = "-1"; }
m->mothurConvert(temp, cutoff);
label = validParameter.validFile(parameters, "label", false);
if (label == "not found") { label = ""; allLines = 1; }
else {
if(label != "all") { m->splitAtDash(label, labels); allLines = 0; }
else { allLines = 1; }
}
if (countfile == "") {
if (namefile == "") {
vector<string> files; files.push_back(taxonomyFileName);
parser.getNameFile(files);
}
}
}
}
catch(exception& e) {
m->errorOut(e, "PhylotypeCommand", "PhylotypeCommand");
exit(1);
}
}
/**********************************************************************************************************************/
int PhylotypeCommand::execute(){
try {
if (abort == true) { if (calledHelp) { return 0; } return 2; }
//reads in taxonomy file and makes all the taxonomies the same length
//by appending the last taxon to a given taxonomy as many times as needed to
//make it as long as the longest taxonomy in the file
TaxEqualizer* taxEqual = new TaxEqualizer(taxonomyFileName, cutoff, outputDir);
if (m->control_pressed) { delete taxEqual; return 0; }
string equalizedTaxFile = taxEqual->getEqualizedTaxFile();
delete taxEqual;
//build taxonomy tree from equalized file
PhyloTree* tree = new PhyloTree(equalizedTaxFile);
vector<int> leaves = tree->getGenusNodes();
//store leaf nodes in current map
for (int i = 0; i < leaves.size(); i++) { currentNodes[leaves[i]] = leaves[i]; }
bool done = false;
if (tree->get(leaves[0]).parent == -1) { m->mothurOut("Empty Tree"); m->mothurOutEndLine(); done = true; }
if (m->control_pressed) { delete tree; return 0; }
ofstream outList, outRabund, outSabund;
map<string, string> variables;
string fileroot = outputDir + m->getRootName(m->getSimpleName(taxonomyFileName));
variables["[filename]"] = fileroot;
variables["[clustertag]"] = "tx";
string sabundFileName = getOutputFileName("sabund", variables);
string rabundFileName = getOutputFileName("rabund", variables);
if (countfile != "") { variables["[tag2]"] = "unique_list"; }
string listFileName = getOutputFileName("list", variables);
if (countfile == "") {
m->openOutputFile(sabundFileName, outSabund);
m->openOutputFile(rabundFileName, outRabund);
outputNames.push_back(sabundFileName); outputTypes["sabund"].push_back(sabundFileName);
outputNames.push_back(rabundFileName); outputTypes["rabund"].push_back(rabundFileName);
}
m->openOutputFile(listFileName, outList);
outputNames.push_back(listFileName); outputTypes["list"].push_back(listFileName);
int count = 1;
//start at leaves of tree and work towards root, processing the labels the user wants
while((!done) && ((allLines == 1) || (labels.size() != 0))) {
string level = toString(count);
count++;
if (m->control_pressed) {
if (countfile == "") { outRabund.close(); outSabund.close(); } outList.close();
for (int i = 0; i < outputNames.size(); i++) { m->mothurRemove(outputNames[i]); }
delete tree; return 0;
}
//is this a level the user want output for
if(allLines == 1 || labels.count(level) == 1){
//output level
m->mothurOut(level); m->mothurOutEndLine();
ListVector list;
list.setLabel(level);
//go through nodes and build listvector
for (itCurrent = currentNodes.begin(); itCurrent != currentNodes.end(); itCurrent++) {
//get parents
TaxNode node = tree->get(itCurrent->first);
parentNodes[node.parent] = node.parent;
vector<string> names = node.accessions;
//make the names compatable with listvector
string name = "";
for (int i = 0; i < names.size(); i++) {
if (names[i] != "unknown") {
if (namefile != "") {
map<string, string>::iterator itNames = namemap.find(names[i]); //make sure this name is in namefile
if (itNames != namemap.end()) { name += namemap[names[i]] + ","; } //you found it in namefile
else { m->mothurOut("[ERROR]: " + names[i] + " is not in your namefile, please correct."); m->mothurOutEndLine(); m->control_pressed = true; }
}else{ name += names[i] + ","; }
}
}
if (m->control_pressed) { break; }
name = name.substr(0, name.length()-1); //rip off extra ','
//add bin to list vector
if (name != "") { list.push_back(name); } //caused by unknown
}
//print listvector
if (!m->printedListHeaders) { list.printHeaders(outList); }
list.print(outList);
if (countfile == "") {
//print rabund
list.getRAbundVector().print(outRabund);
//print sabund
list.getSAbundVector().print(outSabund);
}
labels.erase(level);
}else {
//just get parents
for (itCurrent = currentNodes.begin(); itCurrent != currentNodes.end(); itCurrent++) {
int parent = tree->get(itCurrent->first).parent;
parentNodes[parent] = parent;
}
}
//move up a level
currentNodes = parentNodes;
parentNodes.clear();
//have we reached the rootnode
if (tree->get(currentNodes.begin()->first).parent == -1) { done = true; }
}
outList.close();
if (countfile == "") {
outSabund.close();
outRabund.close();
}
delete tree;
if (m->control_pressed) {
for (int i = 0; i < outputNames.size(); i++) { m->mothurRemove(outputNames[i]); }
return 0;
}
//set list file as new current listfile
string current = "";
itTypes = outputTypes.find("list");
if (itTypes != outputTypes.end()) {
if ((itTypes->second).size() != 0) { current = (itTypes->second)[0]; m->setListFile(current); }
}
//set rabund file as new current rabundfile
itTypes = outputTypes.find("rabund");
if (itTypes != outputTypes.end()) {
if ((itTypes->second).size() != 0) { current = (itTypes->second)[0]; m->setRabundFile(current); }
}
//set sabund file as new current sabundfile
itTypes = outputTypes.find("sabund");
if (itTypes != outputTypes.end()) {
if ((itTypes->second).size() != 0) { current = (itTypes->second)[0]; m->setSabundFile(current); }
}
m->mothurOutEndLine();
m->mothurOut("Output File Names: "); m->mothurOutEndLine();
for (int i = 0; i < outputNames.size(); i++) { m->mothurOut(outputNames[i]); m->mothurOutEndLine(); }
m->mothurOutEndLine();
return 0;
}
catch(exception& e) {
m->errorOut(e, "PhylotypeCommand", "execute");
exit(1);
}
}
/*****************************************************************/
int PhylotypeCommand::readNamesFile() {
try {
ifstream in;
m->openInputFile(namefile, in);
string first, second;
map<string, string>::iterator itNames;
while(!in.eof()) {
in >> first >> second; m->gobble(in);
itNames = namemap.find(first);
if (itNames == namemap.end()) {
namemap[first] = second;
}else { m->mothurOut(first + " has already been seen in namefile, disregarding names file."); m->mothurOutEndLine(); in.close(); namemap.clear(); namefile = ""; return 1; }
}
in.close();
return 0;
}
catch(exception& e) {
m->errorOut(e, "PhylotypeCommand", "readNamesFile");
exit(1);
}
}
/**********************************************************************************************************************/
|