BiopetQScript.scala 4.19 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
/**
 * Biopet is built on top of GATK Queue for building bioinformatic
 * pipelines. It is mainly intended to support LUMC SHARK cluster which is running
 * SGE. But other types of HPC that are supported by GATK Queue (such as PBS)
 * should also be able to execute Biopet tools and pipelines.
 *
 * Copyright 2014 Sequencing Analysis Support Core - Leiden University Medical Center
 *
 * Contact us at: sasc@lumc.nl
 *
 * A dual licensing mode is applied. The source code within this project that are
 * not part of GATK Queue is freely available for non-commercial use under an AGPL
 * license; For commercial users or users who do not want to follow the AGPL
 * license, please contact us to obtain a separate license.
 */
16
17
18
package nl.lumc.sasc.biopet.core

import java.io.File
Peter van 't Hof's avatar
Peter van 't Hof committed
19
import java.io.PrintWriter
20
import nl.lumc.sasc.biopet.core.config.{ ConfigValueIndex, Config, Configurable }
Peter van 't Hof's avatar
Peter van 't Hof committed
21
import org.broadinstitute.gatk.utils.commandline.Argument
Peter van 't Hof's avatar
Peter van 't Hof committed
22
23
import org.broadinstitute.gatk.queue.QSettings
import org.broadinstitute.gatk.queue.function.QFunction
24
import org.broadinstitute.gatk.queue.function.scattergather.ScatterGatherableFunction
25
import org.broadinstitute.gatk.queue.util.{ Logging => GatkLogging }
26
import scala.collection.mutable.ListBuffer
27

Peter van 't Hof's avatar
Peter van 't Hof committed
28
29
30
/**
 * Base for biopet pipeline
 */
31
trait BiopetQScript extends Configurable with GatkLogging {
32

33
  @Argument(doc = "JSON config file(s)", fullName = "config_file", shortName = "config", required = false)
34
  val configfiles: List[File] = Nil
bow's avatar
bow committed
35

36
  var outputDir: String = {
37
    val temp = Config.getValueFromMap(globalConfig.map, ConfigValueIndex(this.configName, configPath, "output_dir"))
38
    if (temp.isEmpty) ""
39
40
41
42
43
    else {
      val t = temp.get.value.toString
      if (!t.endsWith("/")) t + "/" else t
    }
  }
bow's avatar
bow committed
44

45
  @Argument(doc = "Disable all scatters", shortName = "DSC", required = false)
46
  var disableScatter: Boolean = false
47

bow's avatar
bow committed
48
49
  var outputFiles: Map[String, File] = Map()

Peter van 't Hof's avatar
Peter van 't Hof committed
50
  /** Get implemented from org.broadinstitute.gatk.queue.QScript */
Peter van 't Hof's avatar
Peter van 't Hof committed
51
  var qSettings: QSettings
bow's avatar
bow committed
52

Peter van 't Hof's avatar
Peter van 't Hof committed
53
54
55
56
  /** Get implemented from org.broadinstitute.gatk.queue.QScript */
  var functions: Seq[QFunction]

  /** Init for pipeline */
57
  def init
bow's avatar
bow committed
58

Peter van 't Hof's avatar
Peter van 't Hof committed
59
60
  /** Pipeline itself */
  def biopetScript
Peter van 't Hof's avatar
Peter van 't Hof committed
61

Peter van 't Hof's avatar
Peter van 't Hof committed
62
63
64
  /**
   * Script from queue itself, final to force some checks for each pipeline and write report
   */
65
  final def script() {
66
    outputDir = config("output_dir")
67
68
    if (outputDir.isEmpty) outputDir = new File(".").getAbsolutePath()
    else if (!outputDir.endsWith("/")) outputDir += "/"
69
70
    init
    biopetScript
71

72
    if (disableScatter) for (function <- functions) function match {
73
74
75
      case f: ScatterGatherableFunction => f.scatterCount = 1
      case _                            =>
    }
76
    for (function <- functions) function match {
77
78
79
80
      case f: BiopetCommandLineFunctionTrait => {
        f.checkExecutable
        f.afterGraph
      }
Peter van 't Hof's avatar
Peter van 't Hof committed
81
      case _ =>
82
    }
Peter van 't Hof's avatar
Peter van 't Hof committed
83

84
    if (new File(outputDir).canWrite) globalConfig.writeReport(qSettings.runName, outputDir + ".log/" + qSettings.runName)
85
    else BiopetQScript.addError("Output dir: '" + outputDir + "' is not writeable")
86
87

    BiopetQScript.checkErrors
88
  }
bow's avatar
bow committed
89

Peter van 't Hof's avatar
Peter van 't Hof committed
90
91
92
93
94
95
96
97
  /** Get implemented from org.broadinstitute.gatk.queue.QScript */
  def add(functions: QFunction*)

  /**
   * Function to set isIntermediate and add in 1 line
   * @param function
   * @param isIntermediate
   */
bow's avatar
bow committed
98
  def add(function: QFunction, isIntermediate: Boolean = false) {
99
100
101
    function.isIntermediate = isIntermediate
    add(function)
  }
102
}
103
104
105
106

object BiopetQScript extends Logging {
  private val errors: ListBuffer[Exception] = ListBuffer()

107
108
  def addError(error: String, debug: String = null): Unit = {
    val msg = error + (if (debug != null && logger.isDebugEnabled) "; " + debug else "")
109
110
111
112
113
    errors.append(new Exception(msg))
  }

  protected def checkErrors: Unit = {
    if (!errors.isEmpty) {
114
115
116
117
118
119
120
121
      logger.error("*************************")
      logger.error("Biopet found some errors:")
      if (logger.isDebugEnabled) {
        for (e <- errors) {
          logger.error(e.getMessage)
          logger.debug(e.getStackTrace.mkString("Stack trace:\n", "\n", "\n"))
        }
      } else {
Peter van 't Hof's avatar
Peter van 't Hof committed
122
        errors.map(_.getMessage).sorted.distinct.foreach(logger.error(_))
123
124
125
126
      }
      throw new IllegalStateException("Biopet found errors")
    }
  }
127
}