Trait

dagr.tasks.picard

PicardMetricsTask

Related Doc: package picard

Permalink

trait PicardMetricsTask extends AnyRef

Simple trait that requires knowing where a metrics file is for a Picard metric generating tool.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PicardMetricsTask
  2. AnyRef
  3. 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

Abstract Value Members

  1. abstract def in: PathToBam

    Permalink

    The path to the input BAM

  2. abstract def metricsExtension: String

    Permalink

    All Picard metric generating tools should define their own metrics extension.

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from PicardMetricsTask to ArrowAssoc[PicardMetricsTask] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (PicardMetricsTask) ⇒ Boolean, msg: ⇒ Any): PicardMetricsTask

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. def metricsFile(extension: String, kind: PicardOutput.Value): Path

    Permalink

    Build a path to a metrics file (text of PDF) using the appropriate prefix derived from either the supplied prefix, or the input file name.

    Build a path to a metrics file (text of PDF) using the appropriate prefix derived from either the supplied prefix, or the input file name. Useful when a program produces multiple outputs, as in the case of CollectGcBiasMetrics.

  20. def metricsFile: Path

    Permalink

    Gets the metrics file path, assuming that the program generates a single metrics file with a known extension.

  21. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  24. def pathPrefix: PathPrefix

    Permalink

    Method that should be used to fetch the file prefix, instead of accessing prefix directly.

  25. def prefix: Option[PathPrefix]

    Permalink

    The optional path to the prefix of the metrics file

  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  27. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. def [B](y: B): (PicardMetricsTask, B)

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from PicardMetricsTask to any2stringadd[PicardMetricsTask]

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

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

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

Ungrouped