Class

dagr.tasks.picard

DownsampleSam

Related Doc: package picard

Permalink

class DownsampleSam extends PicardTask

Constructs a new DownsampleSam task. If 'strategy' is not supplied then a heuristic is used to determine an appropriate strategy and amount of memory to be used. If 'strategy' is supplied then the caller should specify an appropriate Memory resource level.

Linear Supertypes
PicardTask, Configuration, ConfigurationLike, FixedResources, ScheduleWithEmptyDefaultResources, JarTask, ProcessTask, UnitTask, Schedulable, LazyLogging, Task, Dependable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DownsampleSam
  2. PicardTask
  3. Configuration
  4. ConfigurationLike
  5. FixedResources
  6. ScheduleWithEmptyDefaultResources
  7. JarTask
  8. ProcessTask
  9. UnitTask
  10. Schedulable
  11. LazyLogging
  12. Task
  13. Dependable
  14. AnyRef
  15. 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 DownsampleSam(in: PathToBam, out: PathToBam, proportion: Double, accuracy: Option[Double] = None, strategy: Option[DownsamplingStrategy] = None)

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from DownsampleSam to ArrowAssoc[DownsampleSam] 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. val accuracy: Option[Double]

    Permalink
  12. def addDependent(dependent: Dependable): Unit

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

    Permalink
    Attributes
    protected
    Definition Classes
    DownsampleSamPicardTask
  14. def allTasks: Traversable[Task]

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

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

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

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

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

    Permalink

    the buffer size for the samjdk.

    the buffer size for the samjdk.

    Definition Classes
    PicardTask
  20. def clone(): AnyRef

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

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

    Permalink

    the compress level to use.

    the compress level to use.

    Definition Classes
    PicardTask
  24. def config: Config

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    The path to the JAR to be executed.

    The path to the JAR to be executed.

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

    Permalink

    a list of arguments to the JVM.

    a list of arguments to the JVM.

    Definition Classes
    PicardTask
  47. lazy val logger: Logger

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    FixedResources → Schedulable
  55. var proportion: Double

    Permalink
  56. var quoteIfNecessary: Boolean

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

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

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

    Permalink
    Definition Classes
    FixedResources
  60. def requires(resources: ResourceSet): DownsampleSam.this.type

    Permalink
    Definition Classes
    FixedResources
  61. def resources: ResourceSet

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

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

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

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

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

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

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

    Permalink

    use advanced garbage collection parameters.

    use advanced garbage collection parameters.

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

    Permalink

    set the default validation stringency for Picard.

    set the default validation stringency for Picard.

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

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

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

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

    Permalink

    Sets asynchronous IO on or off.

    Sets asynchronous IO on or off.

    Definition Classes
    PicardTask
  75. def withCompression(i: Int): DownsampleSam.this.type

    Permalink

    Sets the compression level to a specific value.

    Sets the compression level to a specific value.

    Definition Classes
    PicardTask
  76. def withIndexing(indexing: Boolean = true): DownsampleSam.this.type

    Permalink

    Sets asynchronous IO on or off.

    Sets asynchronous IO on or off.

    Definition Classes
    PicardTask
  77. def withName(name: String): DownsampleSam.this.type

    Permalink
    Definition Classes
    Task
  78. def [B](y: B): (DownsampleSam, B)

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

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

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

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

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

Ungrouped