BiopetQScript.scala 4.49 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 / YAML config file(s)", fullName = "config_file", shortName = "config", required = false)
34
  val configfiles: List[File] = Nil
bow's avatar
bow committed
35

36
  @Argument(doc = "Config values, value should be formatted like 'key=value' or 'path:path:key=value'", fullName = "config_value", shortName = "cv", required = false)
37
38
  val configValues: List[String] = Nil

Peter van 't Hof's avatar
Peter van 't Hof committed
39
  var outputDir: File = {
Peter van 't Hof's avatar
Peter van 't Hof committed
40
41
    if (config.contains("output_dir", path = Nil)) config("output_dir", path = Nil).asFile
    else new File(".")
42
  }
bow's avatar
bow committed
43

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

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

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

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

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

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

Peter van 't Hof's avatar
Peter van 't Hof committed
61
62
63
  /**
   * Script from queue itself, final to force some checks for each pipeline and write report
   */
64
  final def script() {
Peter van 't Hof's avatar
Peter van 't Hof committed
65
66
    outputDir = config("output_dir")
    outputDir = outputDir.getAbsoluteFile
67
68
    init
    biopetScript
69

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

Peter van 't Hof's avatar
Peter van 't Hof committed
83
84
85
    if (outputDir.getParentFile.canWrite || (outputDir.exists && outputDir.canWrite))
      globalConfig.writeReport(qSettings.runName, new File(outputDir, ".log/" + qSettings.runName))
    else BiopetQScript.addError("Parent of output dir: '" + outputDir.getParent + "' is not writeable, outputdir can not be created")
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
  /** Get implemented from org.broadinstitute.gatk.queue.QScript */
  def add(functions: QFunction*)

93
  /** Get implemented from org.broadinstitute.gatk.queue.QScript */
Peter van 't Hof's avatar
Peter van 't Hof committed
94
  def addAll(functions: scala.Traversable[org.broadinstitute.gatk.queue.function.QFunction])
95

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

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

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

  protected def checkErrors: Unit = {
    if (!errors.isEmpty) {
117
118
119
120
121
122
123
124
      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
125
        errors.map(_.getMessage).sorted.distinct.foreach(logger.error(_))
126
127
128
129
      }
      throw new IllegalStateException("Biopet found errors")
    }
  }
130
}