Class

dagr.tasks.picard

FilterVcf

Related Doc: package picard

Permalink

class FilterVcf extends PicardTask with Pipe[Vcf, Vcf]

Run's Picard's FilterVcf tool to provide hard filtering of variants.

Linear Supertypes
Pipe[Vcf, Vcf], PicardTask, Configuration, ConfigurationLike, FixedResources, ScheduleWithEmptyDefaultResources, JarTask, ProcessTask, UnitTask, Schedulable, LazyLogging, Task, Dependable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FilterVcf
  2. Pipe
  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 FilterVcf(in: PathToVcf, out: PathToVcf, minHetAlleleBalance: Double = 0.2, minDepth: Int = 0, minQd: Double = 6.0, maxFisherStrandValue: Double = 50, minGenotypeQuality: Int = 20)

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from FilterVcf to ArrowAssoc[FilterVcf] 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 >(path: Path): Pipe[Vcf, Void]

    Permalink
    Definition Classes
    Pipe
  12. def >>(path: Path): Pipe[Vcf, Void]

    Permalink
    Definition Classes
    Pipe
  13. def addPicardArgs(buffer: ListBuffer[Any]): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    FilterVcfPicardTask
  14. def applyResources(resources: ResourceSet): Unit

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

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

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

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

    Permalink

    the buffer size for the samjdk.

    the buffer size for the samjdk.

    Definition Classes
    PicardTask
  19. def clone(): AnyRef

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

    Permalink
    Definition Classes
    ConfigurationLike
  21. 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
  22. var compressionLevel: Option[Int]

    Permalink

    the compress level to use.

    the compress level to use.

    Definition Classes
    PicardTask
  23. def config: Config

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

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

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

    Permalink
    Definition Classes
    ConfigurationLike
  27. def configureExecutableFromBinDirectory(binPath: String, executable: String): Path

    Permalink
    Definition Classes
    ConfigurationLike
  28. 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
  29. 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
  30. def ensuring(cond: (FilterVcf) ⇒ Boolean, msg: ⇒ Any): FilterVcf

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  41. val in: PathToVcf

    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

    The path to the JAR to be executed.

    The path to the JAR to be executed.

    Definition Classes
    PicardTask
  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. val maxFisherStrandValue: Double

    Permalink
  48. val minDepth: Int

    Permalink
  49. val minGenotypeQuality: Int

    Permalink
  50. val minHetAlleleBalance: Double

    Permalink
  51. val minQd: Double

    Permalink
  52. var name: String

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

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

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

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

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

    Permalink
    Definition Classes
    ConfigurationLike
  58. val out: PathToVcf

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

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

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

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

    Permalink
    Definition Classes
    FixedResources
  63. def requires(resources: ResourceSet): FilterVcf.this.type

    Permalink
    Definition Classes
    FixedResources
  64. def resources: ResourceSet

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

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

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

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

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

    Permalink

    use advanced garbage collection parameters.

    use advanced garbage collection parameters.

    Definition Classes
    PicardTask
  70. 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
  71. var validationStringency: Option[ValidationStringency]

    Permalink

    set the default validation stringency for Picard.

    set the default validation stringency for Picard.

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

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

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

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

    Permalink

    Sets asynchronous IO on or off.

    Sets asynchronous IO on or off.

    Definition Classes
    PicardTask
  76. def withCompression(i: Int): FilterVcf.this.type

    Permalink

    Sets the compression level to a specific value.

    Sets the compression level to a specific value.

    Definition Classes
    PicardTask
  77. def withIndexing(indexing: Boolean = true): FilterVcf.this.type

    Permalink

    Sets asynchronous IO on or off.

    Sets asynchronous IO on or off.

    Definition Classes
    PicardTask
  78. def withName(name: String): FilterVcf.this.type

    Permalink
    Definition Classes
    Task
  79. def |[In2 >: Vcf, Out2](next: Pipe[In2, Out2]): Pipe[Vcf, Out2]

    Permalink
    Definition Classes
    Pipe
  80. def [B](y: B): (FilterVcf, B)

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

Inherited from Pipe[Vcf, Vcf]

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

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

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

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

Ungrouped