X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=chopseqscommand.cpp;fp=chopseqscommand.cpp;h=8775d95abab9a4577aaad0f29feec2d15bc39694;hb=ca9ac1d80c62f57270b0dcd49410ebe08a8aecd6;hp=a09ff65856ae39c1e8fbb1a662ed8bacd8860694;hpb=36a867cbd85d9c276d3c8d13f25a150bbbe2466b;p=mothur.git diff --git a/chopseqscommand.cpp b/chopseqscommand.cpp index a09ff65..8775d95 100644 --- a/chopseqscommand.cpp +++ b/chopseqscommand.cpp @@ -11,50 +11,58 @@ #include "sequence.hpp" //********************************************************************************************************************** -vector ChopSeqsCommand::getValidParameters(){ +vector ChopSeqsCommand::setParameters(){ try { - string AlignArray[] = {"fasta","short","numbases","countgaps","keep","outputdir","inputdir"}; - vector myArray (AlignArray, AlignArray+(sizeof(AlignArray)/sizeof(string))); + CommandParameter pfasta("fasta", "InputTypes", "", "", "none", "none", "none",false,true); parameters.push_back(pfasta); + CommandParameter pnumbases("numbases", "Number", "", "0", "", "", "",false,true); parameters.push_back(pnumbases); + CommandParameter pcountgaps("countgaps", "Boolean", "", "F", "", "", "",false,false); parameters.push_back(pcountgaps); + CommandParameter pshort("short", "Boolean", "", "F", "", "", "",false,false); parameters.push_back(pshort); + CommandParameter pkeep("keep", "Multiple", "front-back", "front", "", "", "",false,false); parameters.push_back(pkeep); + CommandParameter pinputdir("inputdir", "String", "", "", "", "", "",false,false); parameters.push_back(pinputdir); + CommandParameter poutputdir("outputdir", "String", "", "", "", "", "",false,false); parameters.push_back(poutputdir); + + vector myArray; + for (int i = 0; i < parameters.size(); i++) { myArray.push_back(parameters[i].name); } return myArray; } catch(exception& e) { - m->errorOut(e, "ChopSeqsCommand", "getValidParameters"); + m->errorOut(e, "ChopSeqsCommand", "setParameters"); exit(1); } } //********************************************************************************************************************** -ChopSeqsCommand::ChopSeqsCommand(){ +string ChopSeqsCommand::getHelpString(){ try { - abort = true; calledHelp = true; - vector tempOutNames; - outputTypes["fasta"] = tempOutNames; - outputTypes["accnos"] = tempOutNames; + string helpString = ""; + helpString += "The chop.seqs command reads a fasta file and outputs a .chop.fasta containing the trimmed sequences. Note: If a sequence is completely 'chopped', an accnos file will be created with the names of the sequences removed. \n"; + helpString += "The chop.seqs command parameters are fasta, numbases, countgaps and keep. fasta is required unless you have a valid current fasta file. numbases is required.\n"; + helpString += "The chop.seqs command should be in the following format: chop.seqs(fasta=yourFasta, numbases=yourNum, keep=yourKeep).\n"; + helpString += "The numbases parameter allows you to specify the number of bases you want to keep.\n"; + helpString += "The keep parameter allows you to specify whether you want to keep the front or the back of your sequence, default=front.\n"; + helpString += "The countgaps parameter allows you to specify whether you want to count gaps as bases, default=false.\n"; + helpString += "The short parameter allows you to specify you want to keep sequences that are too short to chop, default=false.\n"; + helpString += "For example, if you ran chop.seqs with numbases=200 and short=t, if a sequence had 100 bases mothur would keep the sequence rather than eliminate it.\n"; + helpString += "Example chop.seqs(fasta=amazon.fasta, numbases=200, keep=front).\n"; + helpString += "Note: No spaces between parameter labels (i.e. fasta), '=' and parameters (i.e.yourFasta).\n\n"; + return helpString; } catch(exception& e) { - m->errorOut(e, "ChopSeqsCommand", "ChopSeqsCommand"); - exit(1); - } -} -//********************************************************************************************************************** -vector ChopSeqsCommand::getRequiredParameters(){ - try { - string Array[] = {"fasta","numbases"}; - vector myArray (Array, Array+(sizeof(Array)/sizeof(string))); - return myArray; - } - catch(exception& e) { - m->errorOut(e, "ChopSeqsCommand", "getRequiredParameters"); + m->errorOut(e, "ChopSeqsCommand", "getHelpString"); exit(1); } } + //********************************************************************************************************************** -vector ChopSeqsCommand::getRequiredFiles(){ +ChopSeqsCommand::ChopSeqsCommand(){ try { - vector myArray; - return myArray; + abort = true; calledHelp = true; + setParameters(); + vector tempOutNames; + outputTypes["fasta"] = tempOutNames; + outputTypes["accnos"] = tempOutNames; } catch(exception& e) { - m->errorOut(e, "ChopSeqsCommand", "getRequiredFiles"); + m->errorOut(e, "ChopSeqsCommand", "ChopSeqsCommand"); exit(1); } } @@ -67,9 +75,7 @@ ChopSeqsCommand::ChopSeqsCommand(string option) { if(option == "help") { help(); abort = true; calledHelp = true; } else { - //valid paramters for this command - string Array[] = {"fasta","numbases","countgaps","keep","short","outputdir","inputdir"}; - vector myArray (Array, Array+(sizeof(Array)/sizeof(string))); + vector myArray = setParameters(); OptionParser parser(option); map parameters = parser.getParameters(); @@ -104,7 +110,11 @@ ChopSeqsCommand::ChopSeqsCommand(string option) { //check for required parameters fastafile = validParameter.validFile(parameters, "fasta", true); if (fastafile == "not open") { abort = true; } - else if (fastafile == "not found") { m->mothurOut("You must provide a fasta file."); m->mothurOutEndLine(); abort = true; } + else if (fastafile == "not found") { //if there is a current fasta file, use it + fastafile = m->getFastaFile(); + if (fastafile != "") { m->mothurOut("Using " + fastafile + " as input file for the fasta parameter."); m->mothurOutEndLine(); } + else { m->mothurOut("You have no current fastafile and the fasta parameter is required."); m->mothurOutEndLine(); abort = true; } + } //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 = m->hasPath(fastafile); } @@ -131,27 +141,6 @@ ChopSeqsCommand::ChopSeqsCommand(string option) { } //********************************************************************************************************************** -void ChopSeqsCommand::help(){ - try { - m->mothurOut("The chop.seqs command reads a fasta file and outputs a .chop.fasta containing the trimmed sequences. Note: If a sequence is completely 'chopped', an accnos file will be created with the names of the sequences removed. \n"); - m->mothurOut("The chop.seqs command parameters are fasta, numbases, countgaps and keep. fasta and numbases are required required.\n"); - m->mothurOut("The chop.seqs command should be in the following format: chop.seqs(fasta=yourFasta, numbases=yourNum, keep=yourKeep).\n"); - m->mothurOut("The numbases parameter allows you to specify the number of bases you want to keep.\n"); - m->mothurOut("The keep parameter allows you to specify whether you want to keep the front or the back of your sequence, default=front.\n"); - m->mothurOut("The countgaps parameter allows you to specify whether you want to count gaps as bases, default=false.\n"); - m->mothurOut("The short parameter allows you to specify you want to keep sequences that are too short to chop, default=false.\n"); - m->mothurOut("For example, if you ran chop.seqs with numbases=200 and short=t, if a sequence had 100 bases mothur would keep the sequence rather than eliminate it.\n"); - m->mothurOut("Example chop.seqs(fasta=amazon.fasta, numbases=200, keep=front).\n"); - m->mothurOut("Note: No spaces between parameter labels (i.e. fasta), '=' and parameters (i.e.yourFasta).\n\n"); - } - catch(exception& e) { - m->errorOut(e, "ChopSeqsCommand", "help"); - exit(1); - } -} - -//********************************************************************************************************************** - int ChopSeqsCommand::execute(){ try {