Class

dagr.tasks.jeanluc

FilterBam

Related Doc: package jeanluc

Permalink

class FilterBam extends JeanLucTask

Task for filtering a BAM to a specific set of intervals while removing unmapped and duplicate reads.

Linear Supertypes
JeanLucTask, PicardTask, Configuration, ConfigurationLike, FixedResources, ScheduleWithEmptyDefaultResources, JarTask, ProcessTask, UnitTask, Schedulable, LazyLogging, Task, Dependable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FilterBam
  2. JeanLucTask
  3. PicardTask
  4. Configuration
  5. ConfigurationLike
  6. FixedResources
  7. ScheduleWithEmptyDefaultResources
  8. JarTask
  9. ProcessTask
  10. UnitTask
  11. Schedulable
  12. LazyLogging
  13. Task
  14. Dependable
  15. AnyRef
  16. 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 FilterBam(in: PathToBam, out: PathToBam, intervals: Option[PathToIntervals])

    Permalink

Value Members

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

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

    Permalink
    Definition Classes
    Task → Dependable
  3. def !=>(other: Task): other.type

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  9. def ==>(other: MultiTask): other.type

    Permalink
    Definition Classes
    Task → Dependable
  10. def ==>(other: Task): other.type

    Permalink
    Definition Classes
    Task → Dependable
  11. def addJeanLucArgs(buffer: ListBuffer[Any]): Unit

    Permalink
    Definition Classes
    FilterBamJeanLucTask
  12. final def addPicardArgs(buffer: ListBuffer[Any]): Unit

    Permalink

    Override to "hide" the addPicardArgs being addJeanLucArgs.

    Override to "hide" the addPicardArgs being addJeanLucArgs.

    Attributes
    protected
    Definition Classes
    JeanLucTaskPicardTask
  13. def applyResources(resources: ResourceSet): Unit

    Permalink
    Definition Classes
    UnitTask → Schedulable
  14. 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.

    the buffer size for the samjdk.

    Definition Classes
    PicardTask
  18. def clone(): AnyRef

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

    Permalink
    Definition Classes
    ConfigurationLike
  20. def commandName: String

    Permalink

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

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

    Definition Classes
    PicardTask
  21. var compressionLevel: Option[Int]

    Permalink

    the compress level to use.

    the compress level to use.

    Definition Classes
    PicardTask
  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): Path

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

    Permalink

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

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

    Definition Classes
    PicardTask
  28. var createMd5File: Option[Boolean]

    Permalink

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

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

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

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from FilterBam to Ensuring[FilterBam] 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 FilterBam to StringFormat[FilterBam] 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[_ <: FilterBam.this.type]

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

    Permalink
    Definition Classes
    AnyRef → Any
  40. val in: PathToBam

    Permalink
  41. val intervals: Option[PathToIntervals]

    Permalink
  42. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  43. 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
  44. def jarPath: Path

    Permalink

    Override to return the path to the JeanLuc jar.

    Override to return the path to the JeanLuc jar.

    Definition Classes
    JeanLucTaskPicardTask
  45. var jvmArgs: List[String]

    Permalink

    a list of arguments to the JVM.

    a list of arguments to the JVM.

    Definition Classes
    PicardTask
  46. lazy val logger: Logger

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

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

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

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

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

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

    Permalink
    Definition Classes
    ConfigurationLike
  53. val out: PathToBam

    Permalink
  54. def pickResources(availableResources: ResourceSet): Option[ResourceSet]

    Permalink
    Definition Classes
    FixedResources → Schedulable
  55. def removeDependency(task: Task): Boolean

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

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

    Permalink
    Definition Classes
    FixedResources
  58. def requires(resources: ResourceSet): FilterBam.this.type

    Permalink
    Definition Classes
    FixedResources
  59. def resources: ResourceSet

    Permalink
    Definition Classes
    ScheduleWithEmptyDefaultResources
  60. def retry(taskInfo: TaskExecutionInfo, failedOnComplete: Boolean): Option[Task]

    Permalink
    Definition Classes
    Task
  61. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Attributes
    protected
    Definition Classes
    ConfigurationLike
  63. def toString(): String

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

    Permalink

    use advanced garbage collection parameters.

    use advanced garbage collection parameters.

    Definition Classes
    PicardTask
  65. var useAsyncIo: Boolean

    Permalink

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

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

    Definition Classes
    PicardTask
  66. var validationStringency: Option[ValidationStringency]

    Permalink

    set the default validation stringency for Picard.

    set the default validation stringency for Picard.

    Definition Classes
    PicardTask
  67. final def wait(): Unit

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

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

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

    Permalink

    Sets asynchronous IO on or off.

    Sets asynchronous IO on or off.

    Definition Classes
    PicardTask
  71. def withCompression(i: Int): FilterBam.this.type

    Permalink

    Sets the compression level to a specific value.

    Sets the compression level to a specific value.

    Definition Classes
    PicardTask
  72. def withIndexing(indexing: Boolean = true): FilterBam.this.type

    Permalink

    Sets asynchronous IO on or off.

    Sets asynchronous IO on or off.

    Definition Classes
    PicardTask
  73. def withName(name: String): FilterBam.this.type

    Permalink
    Definition Classes
    Task
  74. def [B](y: B): (FilterBam, B)

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

Inherited from JeanLucTask

Inherited from PicardTask

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 FilterBam to any2stringadd[FilterBam]

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

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

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

Ungrouped