BiopetQScript.scala 2.77 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

27
trait BiopetQScript extends Configurable with GatkLogging {
28

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

32
33
34
35
36
37
38
39
  var outputDir: String = {
    val temp = Config.getValueFromMap(Config.global.map, ConfigValueIndex(this.configName, configPath, "output_dir"))
    if (temp.isEmpty) throw new IllegalArgumentException("No output_dir defined in config")
    else {
      val t = temp.get.value.toString
      if (!t.endsWith("/")) t + "/" else t
    }
  }
bow's avatar
bow committed
40

41
  @Argument(doc = "Disable all scatters", shortName = "DSC", required = false)
42
  var disableScatter: Boolean = false
43

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

Peter van 't Hof's avatar
Peter van 't Hof committed
46
  var qSettings: QSettings
bow's avatar
bow committed
47

48
49
  def init
  def biopetScript
bow's avatar
bow committed
50

51
  var functions: Seq[QFunction]
Peter van 't Hof's avatar
Peter van 't Hof committed
52

53
  final def script() {
54
    outputDir = config("output_dir", required = true)
Peter van 't Hof's avatar
Peter van 't Hof committed
55
    if (!outputDir.endsWith("/")) outputDir += "/"
56
57
    init
    biopetScript
58

59
    if (disableScatter) for (function <- functions) function match {
60
61
62
      case f: ScatterGatherableFunction => f.scatterCount = 1
      case _                            =>
    }
63
    for (function <- functions) function match {
Peter van 't Hof's avatar
Peter van 't Hof committed
64
65
      case f: BiopetCommandLineFunctionTrait => f.afterGraph
      case _                                 =>
66
    }
Peter van 't Hof's avatar
Peter van 't Hof committed
67

68
    Config.global.writeReport(qSettings.runName, outputDir + ".log/" + qSettings.runName)
69
  }
bow's avatar
bow committed
70

71
  def add(functions: QFunction*) // Gets implemeted at org.broadinstitute.sting.queue.QScript
bow's avatar
bow committed
72
  def add(function: QFunction, isIntermediate: Boolean = false) {
73
74
75
    function.isIntermediate = isIntermediate
    add(function)
  }
bow's avatar
bow committed
76

77
}