class ClipBam extends FgBioTool with LazyLogging

Annotations
@ClpAnnotation()
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClipBam
  2. LazyLogging
  3. FgBioTool
  4. AnyRef
  5. 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 ClipBam(input: FgBioDef.PathToBam, output: FgBioDef.PathToBam, metrics: Option[FgBioDef.FilePath] = None, ref: FgBioDef.PathToFasta, softClip: Boolean = false, clippingMode: Option[ClippingMode] = None, autoClipAttributes: Boolean = false, upgradeClipping: Boolean = false, readOneFivePrime: Int = 0, readOneThreePrime: Int = 0, readTwoFivePrime: Int = 0, readTwoThreePrime: Int = 0, clipOverlappingReads: Boolean = false)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ClipBam to any2stringadd[ClipBam] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ClipBam, B)
    Implicit
    This member is added by an implicit conversion from ClipBam to ArrowAssoc[ClipBam] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val autoClipAttributes: Boolean
  8. def clipOverlappingReads(f: SamRecord, r: SamRecord): (Int, Int)

    Clips overlapping reads, where both ends of the read pair are mapped to the same chromosome, and in FR orientation.

    Clips overlapping reads, where both ends of the read pair are mapped to the same chromosome, and in FR orientation.

    Attributes
    protected
  9. val clipOverlappingReads: Boolean
  10. val clippingMode: Option[ClippingMode]
  11. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  12. def ensuring(cond: (ClipBam) ⇒ Boolean, msg: ⇒ Any): ClipBam
    Implicit
    This member is added by an implicit conversion from ClipBam to Ensuring[ClipBam] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (ClipBam) ⇒ Boolean): ClipBam
    Implicit
    This member is added by an implicit conversion from ClipBam to Ensuring[ClipBam] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): ClipBam
    Implicit
    This member is added by an implicit conversion from ClipBam to Ensuring[ClipBam] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): ClipBam
    Implicit
    This member is added by an implicit conversion from ClipBam to Ensuring[ClipBam] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def execute(): Unit
    Definition Classes
    ClipBamFgBioTool
  19. def fail(exit: Int, message: String): Nothing

    Fail with a specific error code and message.

    Fail with a specific error code and message.

    Definition Classes
    FgBioTool
  20. def fail(message: String): Nothing

    Fail with the default exit code and a message.

    Fail with the default exit code and a message.

    Definition Classes
    FgBioTool
  21. def fail(exit: Int): Nothing

    Fail with just an exit code.

    Fail with just an exit code.

    Definition Classes
    FgBioTool
  22. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ClipBam to StringFormat[ClipBam] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  24. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. val input: FgBioDef.PathToBam
  27. def invalid(message: String): Nothing

    Generates a new validation exception with the given message.

    Generates a new validation exception with the given message.

    Definition Classes
    FgBioTool
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. lazy val logger: Logger
    Attributes
    protected
    Definition Classes
    LazyLogging
  30. val metrics: Option[FgBioDef.FilePath]
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. val output: FgBioDef.PathToBam
  35. val readOneFivePrime: Int
  36. val readOneThreePrime: Int
  37. val readTwoFivePrime: Int
  38. val readTwoThreePrime: Int
  39. val ref: FgBioDef.PathToFasta
  40. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  41. def toString(): String
    Definition Classes
    AnyRef → Any
  42. val upgradeClipping: Boolean
  43. def validate(test: Boolean, message: ⇒ String): Unit

    Generates a validation exception if the test value is false.

    Generates a validation exception if the test value is false.

    Definition Classes
    FgBioTool
  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  47. def [B](y: B): (ClipBam, B)
    Implicit
    This member is added by an implicit conversion from ClipBam to ArrowAssoc[ClipBam] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. val softClip: Boolean
    Annotations
    @deprecated
    Deprecated

    (Since version 0.4.0) Use clipping-mode instead.

Inherited from LazyLogging

Inherited from FgBioTool

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped