Mercurial > repos > yufei-luo > s_mart
diff commons/tools/TEclassifierPE.py @ 18:94ab73e8a190
Uploaded
author | m-zytnicki |
---|---|
date | Mon, 29 Apr 2013 03:20:15 -0400 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/commons/tools/TEclassifierPE.py Mon Apr 29 03:20:15 2013 -0400 @@ -0,0 +1,193 @@ +#!/usr/bin/env python + +# Copyright INRA (Institut National de la Recherche Agronomique) +# http://www.inra.fr +# http://urgi.versailles.inra.fr +# +# This software is governed by the CeCILL license under French law and +# abiding by the rules of distribution of free software. You can use, +# modify and/ or redistribute the software under the terms of the CeCILL +# license as circulated by CEA, CNRS and INRIA at the following URL +# "http://www.cecill.info". +# +# As a counterpart to the access to the source code and rights to copy, +# modify and redistribute granted by the license, users are provided only +# with a limited warranty and the software's author, the holder of the +# economic rights, and the successive licensors have only limited +# liability. +# +# In this respect, the user's attention is drawn to the risks associated +# with loading, using, modifying and/or developing or reproducing the +# software by the user in light of its specific status of free software, +# that may mean that it is complicated to manipulate, and that also +# therefore means that it is reserved for developers and experienced +# professionals having in-depth computer knowledge. Users are therefore +# encouraged to load and test the software's suitability as regards their +# requirements in conditions enabling the security of their systems and/or +# data to be ensured and, more generally, to use and operate it in the +# same conditions as regards security. +# +# The fact that you are presently reading this means that you have had +# knowledge of the CeCILL license and that you accept its terms. + +import os +import sys + +if not "REPET_PATH" in os.environ.keys(): + print "ERROR: no environment variable REPET_PATH" + sys.exit(1) +sys.path.append(os.environ["REPET_PATH"]) +if not "PYTHONPATH" in os.environ.keys(): + os.environ["PYTHONPATH"] = os.environ["REPET_PATH"] +else: + os.environ["PYTHONPATH"] = "%s:%s" % (os.environ["REPET_PATH"], os.environ["PYTHONPATH"]) + +from commons.core.LoggerFactory import LoggerFactory +from commons.core.utils.RepetOptionParser import RepetOptionParser +from commons.core.checker.ConfigChecker import ConfigRules +from commons.core.checker.ConfigChecker import ConfigChecker +from commons.core.seq.FastaUtils import FastaUtils +from denovo_pipe.ReverseComplementAccordingToClassif import ReverseComplementAccordingToClassif +from denovo_pipe.RenameHeaderClassif import RenameHeaderClassif +from denovo_pipe.DetectTEFeatures import DetectTEFeatures +from denovo_pipe.LaunchPASTEC import LaunchPASTEC +from PASTEC.StatPastec import StatPastec + +LOG_DEPTH = "repet.tools" +#LOG_FORMAT = "%(message)s" + +####TEclassifier PASTEC Edition +# +class TEclassifierPE(object): + + def __init__(self, fastaFileName = "", configFileName = "", addWickerCode = False, reverseComp = False, doClean = False, verbosity = 0): + self._fastaFileName = fastaFileName + self._addWickerCode = addWickerCode + self._reverseComp = reverseComp + self._configFileName = configFileName + self._doClean = doClean + self._verbosity = verbosity + self._projectName = "" + self._log = LoggerFactory.createLogger("%s.%s" % (LOG_DEPTH, self.__class__.__name__), self._verbosity) + + def setAttributesFromCmdLine(self): + description = "TE classifier PASTEC Edition.\n" + description += "Detect TE features on consensus and classify them. Give some classification statistics.\n" + description += "Can rename headers with classification info and Wicker's code at the beginning.\n" + description += "Can reverse-complement consensus if they are detected in reverse strand.\n" + description += "Warning : it's highly advised to use sequences in upper case.\n" + epilog = "\n" + epilog += "Example 1: launch and clean temporary files\n" + epilog += "\t$ python TEclassifierPE.py -i consensus.fa -C TEclassifier.cfg -c\n" + epilog += "\n" + epilog += "Example 2: launch with 'rename headers' and 'reverse-complement' options\n" + epilog += "\t$ python TEclassifierPE.py -i consensus.fa -C TEclassifier.cfg -c -w -r\n" + parser = RepetOptionParser(description = description, epilog = epilog) + parser.add_option("-i", "--fasta", dest = "fastaFileName", action = "store", type = "string", help = "input fasta file name [compulsory] [format: fasta]", default = "") + parser.add_option("-C", "--config", dest = "configFileName",action = "store", type = "string", help = "configuration file name (e.g. TEclassifier.cfg) [compulsory]", default = "") + parser.add_option("-w", "--wicker", dest = "addWickerCode", action = "store_true", help = "add classification info and Wicker's code at the beginning of the headers [optional] [default: False]", default = False) + parser.add_option("-r", "--reverse", dest = "reverseComp", action = "store_true", help = "reverse-complement consensus if they are detected in reverse strand [optional] [default: False]", default = False) + parser.add_option("-c", "--clean", dest = "doClean", action = "store_true", help = "clean temporary files [optional] [default: False]", default = False) + parser.add_option("-v", "--verbosity", dest = "verbosity", action = "store", type = "int", help = "verbosity [optional] [default: 3, from 1 to 4]", default = 3) + options = parser.parse_args()[0] + self._setAttributesFromOptions(options) + + def _setAttributesFromOptions(self, options): + self.setFastaFileName(options.fastaFileName) + self.setAddWickerCode(options.addWickerCode) + self.setReverseComp(options.reverseComp) + self.setConfigFileName(options.configFileName) + self.setDoClean(options.doClean) + self.setVerbosity(options.verbosity) + + def _checkConfig(self): + iConfigRules = ConfigRules() + iConfigRules.addRuleOption(section="project", option ="project_name", mandatory=True, type="string") + sectionName = "classif_consensus" + iConfigRules.addRuleOption(section=sectionName, option ="clean", mandatory=True, type="bool") + iConfigChecker = ConfigChecker(self._configFileName, iConfigRules) + iConfig = iConfigChecker.getConfig() + self._setAttributesFromConfig(iConfig) + + def _setAttributesFromConfig(self, iConfig): + self.setProjectName(iConfig.get("project", "project_name")) + sectionName = "classif_consensus" + self.setDoClean(iConfig.get(sectionName, "clean")) + + def setFastaFileName(self, fastaFileName): + self._fastaFileName = fastaFileName + + def setConfigFileName(self, configFileName): + self._configFileName = configFileName + + def setAddWickerCode(self, addWickerCode): + self._addWickerCode = addWickerCode + + def setReverseComp(self, reverseComp): + self._reverseComp = reverseComp + + def setDoClean(self, doClean): + self._doClean = doClean + + def setVerbosity(self, verbosity): + self._verbosity = verbosity + + def setProjectName(self, projectName): + self._projectName = projectName + + def _checkOptions(self): + if self._fastaFileName == "": + self._logAndRaise("ERROR: Missing input fasta file name") + + def _logAndRaise(self, errorMsg): + self._log.error(errorMsg) + raise Exception(errorMsg) + + def run(self): + LoggerFactory.setLevel(self._log, self._verbosity) + if self._configFileName: + self._checkConfig() + self._checkOptions() + self._log.info("START TEclassifier PASTEC Edition") + self._log.debug("Fasta file name: %s" % self._fastaFileName) + nbSeq = FastaUtils.dbSize(self._fastaFileName) + self._log.debug("Total number of sequences: %i)" % nbSeq) + + #TODO: add step => avoid to re-launch DetectTEFeatures, if error with PASTEC (e.g. wrong bank format) + #step 1 + iDF = DetectTEFeatures(self._fastaFileName, self._projectName, self._configFileName, self._doClean, self._verbosity) + iDF.run() + + #step 2 + iLP = LaunchPASTEC(configFileName = self._configFileName, inputFileName = self._fastaFileName, projectName = self._projectName, verbose = self._verbosity) + iLP.run() + + classifFileName = "%s.classif" % self._projectName + + iSP = StatPastec(classifFileName) + iSP.run() + + if self._reverseComp: + self._log.info("Reverse complement...") + iRevComplAccording2Classif = ReverseComplementAccordingToClassif() + iRevComplAccording2Classif.setFastaFile(self._fastaFileName) + iRevComplAccording2Classif.setClassifFile(classifFileName) + iRevComplAccording2Classif.run() + tmpFastaFileName = "%s_negStrandReversed.fa" % os.path.splitext(self._fastaFileName)[0] + else: + tmpFastaFileName = self._fastaFileName + + if self._addWickerCode: + self._log.info("Rename headers according to Wicker's code...") + iRHC = RenameHeaderClassif(classifFileName, tmpFastaFileName, self._projectName) + iRHC.setOutputFileName("") + iRHC.run() + if self._doClean: + os.remove(tmpFastaFileName) + + self._log.info("END TEclassifier PASTEC Edition") + +if __name__ == "__main__": + iLaunch = TEclassifierPE() + iLaunch.setAttributesFromCmdLine() + iLaunch.run() \ No newline at end of file