MultiSampleQScript.scala 5.48 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
package nl.lumc.sasc.biopet.core

18
19
import java.io.File

20
import nl.lumc.sasc.biopet.core.config.{ Config }
21
import nl.lumc.sasc.biopet.core.summary.{ SummaryQScript, Summarizable }
22
import nl.lumc.sasc.biopet.utils.ConfigUtils
Peter van 't Hof's avatar
Peter van 't Hof committed
23
import org.broadinstitute.gatk.utils.commandline.{ Argument }
24

Peter van 't Hof's avatar
Peter van 't Hof committed
25
26
27
/**
 * This trait creates a structured way of use multisample pipelines
 */
28
29
30
trait MultiSampleQScript extends SummaryQScript {
  qscript =>

Peter van 't Hof's avatar
Peter van 't Hof committed
31
  @Argument(doc = "Only Sample", shortName = "sample", required = false)
32
  private val onlySamples: List[String] = Nil
Peter van 't Hof's avatar
Peter van 't Hof committed
33

34
  require(globalConfig.map.contains("samples"), "No Samples found in config")
Peter van 't Hof's avatar
Peter van 't Hof committed
35

Peter van 't Hof's avatar
Peter van 't Hof committed
36
37
38
39
  /**
   * Sample class with basic functions build in
   * @param sampleId
   */
40
  abstract class AbstractSample(val sampleId: String) extends Summarizable {
Peter van 't Hof's avatar
Peter van 't Hof committed
41
    /** Overrules config of qscript with default sample */
Peter van 't Hof's avatar
Peter van 't Hof committed
42
    val config = new ConfigFunctions(defaultSample = sampleId)
Peter van 't Hof's avatar
Peter van 't Hof committed
43

Peter van 't Hof's avatar
Peter van 't Hof committed
44
45
    /**
     * Library class with basic functions build in
46
     * @param libId
Peter van 't Hof's avatar
Peter van 't Hof committed
47
     */
48
    abstract class AbstractLibrary(val libId: String) extends Summarizable {
Peter van 't Hof's avatar
Peter van 't Hof committed
49
      /** Overrules config of qscript with default sample and default library */
50
      val config = new ConfigFunctions(defaultSample = sampleId, defaultLibrary = libId)
51

Peter van 't Hof's avatar
Peter van 't Hof committed
52
      /** Adds the library jobs */
Peter van 't Hof's avatar
Peter van 't Hof committed
53
      final def addAndTrackJobs(): Unit = {
54
        currentSample = Some(sampleId)
55
        currentLib = Some(libId)
Peter van 't Hof's avatar
Peter van 't Hof committed
56
        addJobs()
57
        addSummarizable(this, "pipeline", Some(sampleId), Some(libId))
Peter van 't Hof's avatar
Peter van 't Hof committed
58
        currentLib = None
59
60
61
        currentSample = None
      }

Peter van 't Hof's avatar
Peter van 't Hof committed
62
      /** Creates a library file with given suffix */
63
      def createFile(suffix: String): File = new File(libDir, sampleId + "-" + libId + suffix)
Peter van 't Hof's avatar
Peter van 't Hof committed
64
65

      /** Returns library directory */
Peter van 't Hof's avatar
Peter van 't Hof committed
66
      def libDir = new File(sampleDir, "lib_" + libId)
67

Peter van 't Hof's avatar
Peter van 't Hof committed
68
      /** Function that add library jobs */
Peter van 't Hof's avatar
Peter van 't Hof committed
69
      protected def addJobs()
70
    }
Peter van 't Hof's avatar
Peter van 't Hof committed
71

Peter van 't Hof's avatar
Peter van 't Hof committed
72
    /** Library type, need implementation in pipeline */
73
    type Library <: AbstractLibrary
Peter van 't Hof's avatar
Peter van 't Hof committed
74

Peter van 't Hof's avatar
Peter van 't Hof committed
75
76
    /** Stores all libraries */
    val libraries: Map[String, Library] = libIds.map(id => id -> makeLibrary(id)).toMap
77

Peter van 't Hof's avatar
Peter van 't Hof committed
78
79
80
81
82
    /**
     * Factory method for Library class
     * @param id SampleId
     * @return Sample class
     */
Peter van 't Hof's avatar
Peter van 't Hof committed
83
    def makeLibrary(id: String): Library
Peter van 't Hof's avatar
Peter van 't Hof committed
84

Peter van 't Hof's avatar
Peter van 't Hof committed
85
86
    /** returns a set with library names */
    protected def libIds: Set[String] = {
87
      ConfigUtils.getMapFromPath(globalConfig.map, List("samples", sampleId, "libraries")).getOrElse(Map()).keySet
88
    }
Peter van 't Hof's avatar
Peter van 't Hof committed
89

Peter van 't Hof's avatar
Peter van 't Hof committed
90
    /** Adds sample jobs */
Peter van 't Hof's avatar
Peter van 't Hof committed
91
    final def addAndTrackJobs(): Unit = {
92
      currentSample = Some(sampleId)
Peter van 't Hof's avatar
Peter van 't Hof committed
93
      addJobs()
94
      addSummarizable(this, "pipeline", Some(sampleId))
95
96
      currentSample = None
    }
Peter van 't Hof's avatar
Peter van 't Hof committed
97

Peter van 't Hof's avatar
Peter van 't Hof committed
98
    /** Function to add sample jobs */
Peter van 't Hof's avatar
Peter van 't Hof committed
99
    protected def addJobs()
Peter van 't Hof's avatar
Peter van 't Hof committed
100

Peter van 't Hof's avatar
Peter van 't Hof committed
101
    /** function add all libraries in one call */
102
    protected final def addPerLibJobs(): Unit = {
103
      for ((libId, library) <- libraries) {
Peter van 't Hof's avatar
Peter van 't Hof committed
104
        library.addAndTrackJobs()
105
      }
bow's avatar
bow committed
106
107
    }

Peter van 't Hof's avatar
Peter van 't Hof committed
108
109
110
111
112
113
114
115
    /**
     * Creates a sample file with given suffix
     * @param suffix
     * @return
     */
    def createFile(suffix: String) = new File(sampleDir, sampleId + suffix)

    /** Returns sample directory */
Peter van 't Hof's avatar
Peter van 't Hof committed
116
    def sampleDir = new File(outputDir, "samples" + File.separator + sampleId)
117
118
  }

Peter van 't Hof's avatar
Peter van 't Hof committed
119
  /** Sample type, need implementation in pipeline */
Peter van 't Hof's avatar
Peter van 't Hof committed
120
121
  type Sample <: AbstractSample

Peter van 't Hof's avatar
Peter van 't Hof committed
122
123
  /**
   * Factory method for Sample class
124
   * @param id SampleId
Peter van 't Hof's avatar
Peter van 't Hof committed
125
126
   * @return Sample class
   */
127
  def makeSample(id: String): Sample
Peter van 't Hof's avatar
Peter van 't Hof committed
128

Peter van 't Hof's avatar
Peter van 't Hof committed
129
130
  /** Stores all samples */
  val samples: Map[String, Sample] = sampleIds.map(id => id -> makeSample(id)).toMap
131

132
  /** Returns a list of all sampleIDs */
133
  protected def sampleIds: Set[String] = ConfigUtils.any2map(globalConfig.map("samples")).keySet
134

Peter van 't Hof's avatar
Peter van 't Hof committed
135
  /** Runs addAndTrackJobs method for each sample */
Peter van 't Hof's avatar
Peter van 't Hof committed
136
  final def addSamplesJobs() {
137
138
139
140
    if (onlySamples.isEmpty) {
      samples.foreach { case (sampleId, sample) => sample.addAndTrackJobs() }
      addMultiSampleJobs()
    } else onlySamples.foreach(sampleId => samples.get(sampleId) match {
141
142
143
      case Some(sample) => sample.addAndTrackJobs()
      case None         => logger.warn("sampleId '" + sampleId + "' not found")
    })
144
145
  }

146
147
148
149
150
  /**
   * Method where the multisample jobs should be added, this will be executed only when running the -sample argument is not given
   */
  def addMultiSampleJobs()

Peter van 't Hof's avatar
Peter van 't Hof committed
151
  /** Stores sample state */
152
153
  private var currentSample: Option[String] = None

Peter van 't Hof's avatar
Peter van 't Hof committed
154
155
156
157
  /** Stores library state */
  private var currentLib: Option[String] = None

  /** Prefix full path with sample and library for jobs that's are created in current state */
158
  override protected[core] def configFullPath: List[String] = {
Peter van 't Hof's avatar
Peter van 't Hof committed
159
160
161
162
    val s = currentSample match {
      case Some(s) => "samples" :: s :: Nil
      case _       => Nil
    }
Peter van 't Hof's avatar
Peter van 't Hof committed
163
    val l = currentLib match {
Peter van 't Hof's avatar
Peter van 't Hof committed
164
165
166
167
      case Some(l) => "libraries" :: l :: Nil
      case _       => Nil
    }
    s ::: l ::: super.configFullPath
168
  }
169
}