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: 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 FilterVcf to any2stringadd[FilterVcf] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  5. 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()
  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 >(path: Path): Pipe[Vcf, Void]

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    FilterVcfPicardTask
  17. def allTasks: Traversable[Task]

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

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

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

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

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

    Permalink

    the buffer size for the samjdk.

    the buffer size for the samjdk.

    Definition Classes
    PicardTask
  23. def clone(): AnyRef

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

    Permalink
    Definition Classes
    ConfigurationLike
  25. lazy val commandName: String

    Permalink

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

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

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

    Permalink

    the compress level to use.

    the compress level to use.

    Definition Classes
    PicardTask
  27. def config: Config

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

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

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

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

    Permalink
    Definition Classes
    ConfigurationLike
  32. 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
  33. 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
  34. def discardError(): Pipe[Vcf, Vcf]

    Permalink
    Definition Classes
    Pipe
  35. 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
  36. 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
  37. 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
  38. 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
  39. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  42. 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()
  43. final def getClass(): Class[_]

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

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

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

    Permalink
    Definition Classes
    Task → Dependable
  47. val in: PathToVcf

    Permalink
  48. final def isInstanceOf[T0]: Boolean

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

    Permalink

    The path to the JAR to be executed.

    The path to the JAR to be executed.

    Definition Classes
    PicardTask
  51. var jvmArgs: List[String]

    Permalink

    a list of arguments to the JVM.

    a list of arguments to the JVM.

    Definition Classes
    PicardTask
  52. lazy val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    LazyLogging
  53. val maxFisherStrandValue: Double

    Permalink
  54. val minDepth: Int

    Permalink
  55. val minGenotypeQuality: Int

    Permalink
  56. val minHetAlleleBalance: Double

    Permalink
  57. val minQd: Double

    Permalink
  58. var name: String

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

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

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

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

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

    Permalink
    Definition Classes
    ConfigurationLike
  64. val out: PathToVcf

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

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

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

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

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

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

    Permalink
    Definition Classes
    FixedResources
  71. def resources: ResourceSet

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

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

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

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

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

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

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

    Permalink

    use advanced garbage collection parameters.

    use advanced garbage collection parameters.

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

    Permalink

    set the default validation stringency for Picard.

    set the default validation stringency for Picard.

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

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

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

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

    Permalink

    Sets asynchronous IO on or off.

    Sets asynchronous IO on or off.

    Definition Classes
    PicardTask
  85. 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
  86. def withIndexing(indexing: Boolean = true): FilterVcf.this.type

    Permalink

    Sets asynchronous IO on or off.

    Sets asynchronous IO on or off.

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

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

    Permalink
    Definition Classes
    Pipe
  89. 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