Class

dagr.tasks.fgbio

GroupReadsByUmi

Related Doc: package fgbio

Permalink

class GroupReadsByUmi extends FgBioTask with Pipe[SamOrBam, SamOrBam]

Task to invoke GroupReadsByUmi.

Linear Supertypes
Pipe[SamOrBam, SamOrBam], FgBioTask, Configuration, ConfigurationLike, FixedResources, ScheduleWithEmptyDefaultResources, JarTask, ProcessTask, UnitTask, Schedulable, LazyLogging, Task, Dependable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. GroupReadsByUmi
  2. Pipe
  3. FgBioTask
  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 GroupReadsByUmi(in: commons.CommonsDef.PathToBam, out: commons.CommonsDef.PathToBam, rawTag: Option[String] = None, assignTag: String, minMapQ: Option[Int] = None, strategy: AssignmentStrategy = AssignmentStrategy.Adjacency, edits: Option[Int] = None, tmpDir: Option[commons.CommonsDef.DirPath] = 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 GroupReadsByUmi to any2stringadd[GroupReadsByUmi] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  5. def ->[B](y: B): (GroupReadsByUmi, B)

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

    Permalink
    Definition Classes
    Dependable
  7. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. final def ==>(other: Dependable): Dependable

    Permalink
    Definition Classes
    Dependable
  9. def >(path: Path): Pipe[SamOrBam, Void]

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

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

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

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

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

    Permalink

    Implement this to add the tool-specific arguments

    Implement this to add the tool-specific arguments

    Attributes
    protected
    Definition Classes
    GroupReadsByUmiFgBioTask
  15. def applyResources(resources: ResourceSet): Unit

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

    Permalink
    Definition Classes
    FgBioTask → 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. val assignTag: String

    Permalink
  20. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. def commandLineName: 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
    FgBioTask
  23. var compressionLevel: Option[Int]

    Permalink

    the compress level to use for HTSJDK.

    the compress level to use for HTSJDK.

    Definition Classes
    FgBioTask
  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. def discardError(): Pipe[SamOrBam, SamOrBam]

    Permalink
    Definition Classes
    Pipe
  30. val edits: Option[Int]

    Permalink
  31. def ensuring(cond: (GroupReadsByUmi) ⇒ Boolean, msg: ⇒ Any): GroupReadsByUmi

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from GroupReadsByUmi to Ensuring[GroupReadsByUmi] 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 fgBioJar: Path

    Permalink

    Can be overridden to use a specific FgBio jar.

    Can be overridden to use a specific FgBio jar.

    Attributes
    protected
    Definition Classes
    FgBioTask
  38. def finalize(): Unit

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  43. val in: commons.CommonsDef.PathToBam

    Permalink
  44. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  45. 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
  46. lazy val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    LazyLogging
  47. val minMapQ: Option[Int]

    Permalink
  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. val out: commons.CommonsDef.PathToBam

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    ProcessTask
  57. val rawTag: Option[String]

    Permalink
  58. def removeDependency(task: Task): Boolean

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

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

    Permalink
    Definition Classes
    FixedResources
  61. def requires(resources: ResourceSet): GroupReadsByUmi.this.type

    Permalink
    Definition Classes
    FixedResources
  62. def resources: ResourceSet

    Permalink
    Definition Classes
    ScheduleWithEmptyDefaultResources
  63. val strategy: AssignmentStrategy

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    ConfigurationLike
  66. def tasksDependedOn: Traversable[Task]

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

    Permalink
    Attributes
    protected[dagr.core]
    Definition Classes
    Task
  68. val tmpDir: Option[commons.CommonsDef.DirPath]

    Permalink
  69. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  73. def withCompression(i: Int): GroupReadsByUmi.this.type

    Permalink

    Sets the compression level to a specific value.

    Sets the compression level to a specific value.

    Definition Classes
    FgBioTask
  74. def withName(name: String): GroupReadsByUmi.this.type

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

    Permalink
    Definition Classes
    Pipe
  76. def [B](y: B): (GroupReadsByUmi, B)

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

Inherited from Pipe[SamOrBam, SamOrBam]

Inherited from FgBioTask

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

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

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

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

Ungrouped