Class/Object

dagr.tasks.picard

PicardTask

Related Docs: object PicardTask | package picard

Permalink

abstract class PicardTask extends ProcessTask with JarTask with FixedResources with Configuration

Simple class to run any Picard command. Specific Picard command classes should extend this. Since the order of args is important to a task, an sub-class should call getPicardArgs before adding any tasks to args, and then call super.getTasks if getTasks is overriden.

Linear Supertypes
Configuration, ConfigurationLike, FixedResources, ScheduleWithEmptyDefaultResources, JarTask, ProcessTask, UnitTask, Schedulable, LazyLogging, Task, Dependable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PicardTask
  2. Configuration
  3. ConfigurationLike
  4. FixedResources
  5. ScheduleWithEmptyDefaultResources
  6. JarTask
  7. ProcessTask
  8. UnitTask
  9. Schedulable
  10. LazyLogging
  11. Task
  12. Dependable
  13. AnyRef
  14. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PicardTask(jvmArgs: List[String] = Nil, useAdvancedGcOptions: Boolean = true, validationStringency: Option[ValidationStringency] = Some(ValidationStringency.SILENT), useAsyncIo: Boolean = false, compressionLevel: Option[Int] = None, createIndex: Option[Boolean] = Some(true), createMd5File: Option[Boolean] = None, bufferSize: Option[Int] = Some(128 * 1024))

    Permalink

    jvmArgs

    a list of arguments to the JVM.

    useAdvancedGcOptions

    use advanced garbage collection parameters.

    validationStringency

    set the default validation stringency for Picard.

    useAsyncIo

    true if we are to use asynchronous IO, false otherwise.

    compressionLevel

    the compress level to use.

    createIndex

    true if we are to create an index, false otherwise.

    createMd5File

    true if we are to create an Md5 file, false otherwise.

    bufferSize

    the buffer size for the samjdk.

Abstract Value Members

  1. abstract def addPicardArgs(buffer: ListBuffer[Any]): Unit

    Permalink
    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. def !=>(other: Dependable): Unit

    Permalink
    Definition Classes
    Task → Dependable
  3. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from PicardTask to any2stringadd[PicardTask] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  5. def ->[B](y: B): (PicardTask, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from PicardTask to ArrowAssoc[PicardTask] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. def ::(other: Option[Dependable]): Dependable

    Permalink
    Definition Classes
    Dependable
  7. def ::(other: Dependable): Dependable

    Permalink
    Definition Classes
    Dependable
  8. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. final def ==>(other: Option[Dependable]): Dependable

    Permalink
    Definition Classes
    Dependable
  10. final def ==>(other: Dependable): Dependable

    Permalink
    Definition Classes
    Dependable
  11. def addDependent(dependent: Dependable): Unit

    Permalink
    Definition Classes
    Task → Dependable
  12. def allTasks: Traversable[Task]

    Permalink
    Definition Classes
    Task → Dependable
  13. def applyResources(resources: ResourceSet): Unit

    Permalink
    Definition Classes
    UnitTask → Schedulable
  14. final def args: Seq[Any]

    Permalink
    Definition Classes
    PicardTask → ProcessTask
  15. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  16. def asType[T](path: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    ConfigurationLike
  17. var bufferSize: Option[Int]

    Permalink

    the buffer size for the samjdk.

  18. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. def commandLineName(name: String): String

    Permalink
    Definition Classes
    ConfigurationLike
  20. lazy val commandName: String

    Permalink

    Looks up the first super class that does not have "$anon$" in its name.

  21. var compressionLevel: Option[Int]

    Permalink

    the compress level to use.

  22. def config: Config

    Permalink
    Attributes
    protected
    Definition Classes
    Configuration → ConfigurationLike
  23. def configure[T](path: String, defaultValue: T)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): T

    Permalink
    Definition Classes
    ConfigurationLike
  24. def configure[T](path: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): T

    Permalink
    Definition Classes
    ConfigurationLike
  25. def configureExecutable(path: String, executable: String): Path

    Permalink
    Definition Classes
    ConfigurationLike
  26. def configureExecutableFromBinDirectory(binPath: String, executable: String, subDir: Option[Path]): Path

    Permalink
    Definition Classes
    ConfigurationLike
  27. var createIndex: Option[Boolean]

    Permalink

    true if we are to create an index, false otherwise.

  28. var createMd5File: Option[Boolean]

    Permalink

    true if we are to create an Md5 file, false otherwise.

  29. def ensuring(cond: (PicardTask) ⇒ Boolean, msg: ⇒ Any): PicardTask

    Permalink
    Implicit information
    This member is added by an implicit conversion from PicardTask to Ensuring[PicardTask] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  30. def ensuring(cond: (PicardTask) ⇒ Boolean): PicardTask

    Permalink
    Implicit information
    This member is added by an implicit conversion from PicardTask to Ensuring[PicardTask] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  31. def ensuring(cond: Boolean, msg: ⇒ Any): PicardTask

    Permalink
    Implicit information
    This member is added by an implicit conversion from PicardTask to Ensuring[PicardTask] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  32. def ensuring(cond: Boolean): PicardTask

    Permalink
    Implicit information
    This member is added by an implicit conversion from PicardTask to Ensuring[PicardTask] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  33. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  34. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  35. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  36. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from PicardTask to StringFormat[PicardTask] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  37. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  38. final def getTasks: Traversable[_ <: PicardTask.this.type]

    Permalink
    Definition Classes
    UnitTask → Task
  39. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  40. def headTasks: Traversable[Task]

    Permalink
    Definition Classes
    Task → Dependable
  41. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  42. def jarArgs(jarPath: Path, jvmArgs: Traversable[String] = Nil, jvmProperties: Map[String, String] = Map.empty, jvmMemory: Memory, useAdvancedGcOptions: Boolean = true): List[String]

    Permalink
    Attributes
    protected
    Definition Classes
    JarTask
  43. def jarPath: Path

    Permalink

    The path to the JAR to be executed.

  44. var jvmArgs: List[String]

    Permalink

    a list of arguments to the JVM.

  45. lazy val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    LazyLogging
  46. var name: String

    Permalink
    Definition Classes
    Task
  47. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  48. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  49. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  50. def onComplete(exitCode: Int): Boolean

    Permalink
    Definition Classes
    Task
  51. def optionallyConfigure[T](path: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): Option[T]

    Permalink
    Definition Classes
    ConfigurationLike
  52. def pickResources(availableResources: ResourceSet): Option[ResourceSet]

    Permalink
    Definition Classes
    FixedResources → Schedulable
  53. var quoteIfNecessary: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    ProcessTask
  54. def removeDependency(task: Task): Boolean

    Permalink
    Definition Classes
    Task
  55. def requires(cores: Double, memory: String): PicardTask.this.type

    Permalink
    Definition Classes
    FixedResources
  56. def requires(cores: Cores, memory: Memory): PicardTask.this.type

    Permalink
    Definition Classes
    FixedResources
  57. def requires(resources: ResourceSet): PicardTask.this.type

    Permalink
    Definition Classes
    FixedResources
  58. def resources: ResourceSet

    Permalink
    Definition Classes
    ScheduleWithEmptyDefaultResources
  59. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  60. def systemPath: Seq[Path]

    Permalink
    Attributes
    protected
    Definition Classes
    ConfigurationLike
  61. def tailTasks: Traversable[Task]

    Permalink
    Definition Classes
    Task → Dependable
  62. def tasksDependedOn: Traversable[Task]

    Permalink
    Attributes
    protected[dagr.core]
    Definition Classes
    Task
  63. def tasksDependingOnThisTask: Traversable[Task]

    Permalink
    Attributes
    protected[dagr.core]
    Definition Classes
    Task
  64. def toString(): String

    Permalink
    Definition Classes
    ProcessTask → AnyRef → Any
  65. var useAdvancedGcOptions: Boolean

    Permalink

    use advanced garbage collection parameters.

  66. var useAsyncIo: Boolean

    Permalink

    true if we are to use asynchronous IO, false otherwise.

  67. var validationStringency: Option[ValidationStringency]

    Permalink

    set the default validation stringency for Picard.

  68. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  69. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  70. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  71. def withAsyncIo(async: Boolean = true): PicardTask.this.type

    Permalink

    Sets asynchronous IO on or off.

  72. def withCompression(i: Int): PicardTask.this.type

    Permalink

    Sets the compression level to a specific value.

  73. def withIndexing(indexing: Boolean = true): PicardTask.this.type

    Permalink

    Sets asynchronous IO on or off.

  74. def withName(name: String): PicardTask.this.type

    Permalink
    Definition Classes
    Task
  75. def [B](y: B): (PicardTask, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from PicardTask to ArrowAssoc[PicardTask] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Configuration

Inherited from ConfigurationLike

Inherited from FixedResources

Inherited from ScheduleWithEmptyDefaultResources

Inherited from JarTask

Inherited from ProcessTask

Inherited from UnitTask

Inherited from Schedulable

Inherited from LazyLogging

Inherited from Task

Inherited from Dependable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from PicardTask to any2stringadd[PicardTask]

Inherited by implicit conversion StringFormat from PicardTask to StringFormat[PicardTask]

Inherited by implicit conversion Ensuring from PicardTask to Ensuring[PicardTask]

Inherited by implicit conversion ArrowAssoc from PicardTask to ArrowAssoc[PicardTask]

Ungrouped