org.bdgenomics.adam.rdd

ADAMRecordRDDFunctions

class ADAMRecordRDDFunctions extends ADAMSequenceDictionaryRDDAggregator[ADAMRecord]

Linear Supertypes
ADAMSequenceDictionaryRDDAggregator[ADAMRecord], Logging, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ADAMRecordRDDFunctions
  2. ADAMSequenceDictionaryRDDAggregator
  3. Logging
  4. Serializable
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ADAMRecordRDDFunctions(rdd: RDD[ADAMRecord])

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def adamBQSR(knownSnps: Broadcast[SnpTable]): RDD[ADAMRecord]

  7. def adamCharacterizeTagValues(tag: String): Map[Any, Long]

    Calculates the set of unique attribute values that occur for the given tag, and the number of time each value occurs.

    Calculates the set of unique attribute values that occur for the given tag, and the number of time each value occurs.

    tag

    The name of the optional field whose values are to be counted.

    returns

    A Map whose keys are the values of the tag, and whose values are the number of time each tag-value occurs.

  8. def adamCharacterizeTags(): RDD[(String, Long)]

    Converts a set of records into an RDD containing the pairs of all unique tagStrings within the records, along with the count (number of records) which have that particular attribute.

    Converts a set of records into an RDD containing the pairs of all unique tagStrings within the records, along with the count (number of records) which have that particular attribute.

    returns

    An RDD of attribute name / count pairs.

  9. def adamConvertToSAM(): (RDD[SAMRecordWritable], SAMFileHeader)

    Converts an RDD of ADAM read records into SAM records.

    Converts an RDD of ADAM read records into SAM records.

    returns

    Returns a SAM/BAM formatted RDD of reads, as well as the file header.

  10. def adamFilterRecordsWithTag(tagName: String): RDD[ADAMRecord]

    Returns the subset of the ADAMRecords which have an attribute with the given name.

    Returns the subset of the ADAMRecords which have an attribute with the given name.

    tagName

    The name of the attribute to filter on (should be length 2)

    returns

    An RDD[ADAMRecord] containing the subset of records with a tag that matches the given name.

  11. def adamFlagStat(): (FlagStatMetrics, FlagStatMetrics)

  12. def adamGetReadGroupDictionary(): RecordGroupDictionary

    Collects a dictionary summarizing the read groups in an RDD of ADAMRecords.

    Collects a dictionary summarizing the read groups in an RDD of ADAMRecords.

    returns

    A dictionary describing the read groups in this RDD.

  13. def adamGetSequenceDictionary(): SequenceDictionary

    Aggregates together a sequence dictionary from the different individual reference sequences used in this dataset.

    Aggregates together a sequence dictionary from the different individual reference sequences used in this dataset.

    returns

    A sequence dictionary describing the reference contigs in this dataset.

    Definition Classes
    ADAMSequenceDictionaryRDDAggregator
  14. def adamMarkDuplicates(): RDD[ADAMRecord]

  15. def adamRealignIndels(): RDD[ADAMRecord]

  16. def adamRecords2Pileup(secondaryAlignments: Boolean = false): RDD[ADAMPileup]

    Groups all reads by reference position and returns a non-aggregated pileup RDD.

    Groups all reads by reference position and returns a non-aggregated pileup RDD.

    secondaryAlignments

    Creates pileups for non-primary aligned reads. Default is false.

    returns

    ADAMPileup without aggregation

  17. def adamRecords2Rods(bucketSize: Int = 1000, secondaryAlignments: Boolean = false): RDD[ADAMRod]

    Groups all reads by reference position, with all reference position bases grouped into a rod.

    Groups all reads by reference position, with all reference position bases grouped into a rod.

    bucketSize

    Size in basepairs of buckets. Larger buckets take more time per bucket to convert, but have lower skew. Default is 1000.

    secondaryAlignments

    Creates rods for non-primary aligned reads. Default is false.

    returns

    RDD of ADAMRods.

  18. def adamSAMSave(filePath: String, asSam: Boolean = true): Unit

    Saves an RDD of ADAM read data into the SAM/BAM format.

    Saves an RDD of ADAM read data into the SAM/BAM format.

    filePath

    Path to save files to.

    asSam

    Selects whether to save as SAM or BAM. The default value is true (save in SAM format).

  19. def adamSingleReadBuckets(): RDD[SingleReadBucket]

    Groups all reads by record group and read name

    Groups all reads by record group and read name

    returns

    SingleReadBuckets with primary, secondary and unmapped reads

  20. def adamSortReadsByReferencePosition(): RDD[ADAMRecord]

  21. def adamTrimLowQualityReadGroups(phredThreshold: Int = 20): RDD[ADAMRecord]

    Trims low quality read prefix/suffixes.

    Trims low quality read prefix/suffixes. The average read prefix/suffix quality is calculated from the Phred scaled qualities for read bases. We trim suffixes/prefixes that are below a user provided threshold.

    phredThreshold

    Phred score for trimming. Defaut value is 20.

    returns

    Returns an RDD of trimmed reads.

  22. def adamTrimReads(trimStart: Int, trimEnd: Int, readGroup: Int = 1): RDD[ADAMRecord]

    Trims bases from the start and end of all reads in an RDD.

    Trims bases from the start and end of all reads in an RDD.

    trimStart

    Number of bases to trim from the start of the read.

    trimEnd

    Number of bases to trim from the end of the read.

    readGroup

    Optional parameter specifying which read group to trim. If omitted, all reads are trimmed.

    returns

    Returns an RDD of trimmed reads.

    Note

    Trimming parameters must be >= 0.

  23. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  24. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  29. def getSequenceRecordsFromElement(elem: ADAMRecord): Set[SequenceRecord]

    For a single RDD element, returns 0+ sequence record elements.

    For a single RDD element, returns 0+ sequence record elements.

    elem

    Element from which to extract sequence records.

    returns

    A seq of sequence records.

    Definition Classes
    ADAMRecordRDDFunctionsADAMSequenceDictionaryRDDAggregator
  30. def hashCode(): Int

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

    Definition Classes
    Any
  32. def isTraceEnabled(): Boolean

    Attributes
    protected
    Definition Classes
    Logging
  33. def log: Logger

    Attributes
    protected
    Definition Classes
    Logging
  34. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  35. def logDebug(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  36. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  37. def logError(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  38. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  39. def logInfo(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  40. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  41. def logTrace(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  42. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  43. def logWarning(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  44. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  45. final def notify(): Unit

    Definition Classes
    AnyRef
  46. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  47. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  48. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ADAMSequenceDictionaryRDDAggregator[ADAMRecord]

Inherited from Logging

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped