Class/Object

dagr.tasks.fgbio

FgBioTask

Related Docs: object FgBioTask | package fgbio

Permalink

abstract class FgBioTask extends ProcessTask with JarTask with FixedResources with Configuration

Base Task for any task in the FgBio jar.

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. FgBioTask
  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 FgBioTask(compressionLevel: Option[Int] = None)

    Permalink

    compressionLevel

    the compress level to use for HTSJDK.

Abstract Value Members

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

    Permalink

    Implement this to add the tool-specific arguments

    Implement this to add the tool-specific arguments

    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 FgBioTask to any2stringadd[FgBioTask] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  5. def ->[B](y: B): (FgBioTask, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from FgBioTask to ArrowAssoc[FgBioTask] 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
    FgBioTask → 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. def clone(): AnyRef

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

    Permalink
    Definition Classes
    ConfigurationLike
  19. lazy val commandName: String

    Permalink

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

  20. var compressionLevel: Option[Int]

    Permalink

    the compress level to use for HTSJDK.

  21. def config: Config

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

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

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

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

    Permalink
    Definition Classes
    ConfigurationLike
  26. def ensuring(cond: (FgBioTask) ⇒ Boolean, msg: ⇒ Any): FgBioTask

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  32. def fgBioJar: Path

    Permalink

    Can be overridden to use a specific FgBio jar.

    Can be overridden to use a specific FgBio jar.

    Attributes
    protected
  33. def finalize(): Unit

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

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

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

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

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

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

    Permalink
    Definition Classes
    Any
  40. 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
  41. lazy val logger: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    FixedResources
  53. def requires(resources: ResourceSet): FgBioTask.this.type

    Permalink
    Definition Classes
    FixedResources
  54. def resources: ResourceSet

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

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

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

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

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

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

    Permalink
    Definition Classes
    ProcessTask → AnyRef → Any
  61. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  64. def withCompression(i: Int): FgBioTask.this.type

    Permalink

    Sets the compression level to a specific value.

  65. def withName(name: String): FgBioTask.this.type

    Permalink
    Definition Classes
    Task
  66. def [B](y: B): (FgBioTask, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from FgBioTask to ArrowAssoc[FgBioTask] 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 FgBioTask to any2stringadd[FgBioTask]

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

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

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

Ungrouped