Packages

case class Sample(sampleOrdinal: Int, sampleId: String, sampleName: String, libraryId: String, project: Option[String] = None, description: Option[String] = None, lane: Option[Int] = None, i7IndexBases: Option[String] = None, i5IndexBases: Option[String] = None, extendedAttributes: Map[String, String] = Map.empty) extends Product with Serializable

Represents information about a sample within an Illumina Experiment Manager sample sheet.

Optionally contains information about dual indexes: i7 and i5.

sampleOrdinal

the sample ordinal if this sample belongs to a sample set.

sampleId

the unique sample identifier.

sampleName

the sample name.

libraryId

the library identifier.

project

the project identifier.

description

the sample description.

lane

the lane number for the sample.

i7IndexBases

the sample barcode bases in the i7 read.

i5IndexBases

the sample barcode bases in the i5 read.

extendedAttributes

a map of non-standard or site-specific extended attributes. Keys should be upper-case.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Sample
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. 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 Sample(sampleOrdinal: Int, sampleId: String, sampleName: String, libraryId: String, project: Option[String] = None, description: Option[String] = None, lane: Option[Int] = None, i7IndexBases: Option[String] = None, i5IndexBases: Option[String] = None, extendedAttributes: Map[String, String] = Map.empty)

    sampleOrdinal

    the sample ordinal if this sample belongs to a sample set.

    sampleId

    the unique sample identifier.

    sampleName

    the sample name.

    libraryId

    the library identifier.

    project

    the project identifier.

    description

    the sample description.

    lane

    the lane number for the sample.

    i7IndexBases

    the sample barcode bases in the i7 read.

    i5IndexBases

    the sample barcode bases in the i5 read.

    extendedAttributes

    a map of non-standard or site-specific extended attributes. Keys should be upper-case.

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 Sample to any2stringadd[Sample] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Sample, B)
    Implicit
    This member is added by an implicit conversion from Sample to ArrowAssoc[Sample] 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. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val description: Option[String]
  9. def ensuring(cond: (Sample) ⇒ Boolean, msg: ⇒ Any): Sample
    Implicit
    This member is added by an implicit conversion from Sample to Ensuring[Sample] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (Sample) ⇒ Boolean): Sample
    Implicit
    This member is added by an implicit conversion from Sample to Ensuring[Sample] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): Sample
    Implicit
    This member is added by an implicit conversion from Sample to Ensuring[Sample] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): Sample
    Implicit
    This member is added by an implicit conversion from Sample to Ensuring[Sample] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def extendedAttribute(name: String): Option[String]

    Gets an extended attribute for the given column name.

    Gets an extended attribute for the given column name. The column name can be any case.

  15. val extendedAttributes: Map[String, String]
  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Sample to StringFormat[Sample] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  19. val i5IndexBases: Option[String]
  20. val i7IndexBases: Option[String]
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. val lane: Option[Int]
  23. val libraryId: String
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  27. val project: Option[String]
  28. def sampleBarcodeBases: Seq[Option[String]]

    Returns the sample barcodes in order of sequencing.

  29. lazy val sampleBarcodeBytes: Array[Byte]
  30. lazy val sampleBarcodeString: String
  31. def sampleBarcodes: Seq[Option[String]]
  32. val sampleId: String
  33. val sampleName: String
  34. val sampleOrdinal: Int
  35. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. def →[B](y: B): (Sample, B)
    Implicit
    This member is added by an implicit conversion from Sample to ArrowAssoc[Sample] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped