ADAM_2.12: Core 0.36.0 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package org
  Definition Classes
    root
-  package bdgenomics
  Definition Classes
    org
-  package adam
  Definition Classes
    bdgenomics
-  package algorithms
  Definition Classes
    adam
-  package converters
  Definition Classes
    adam
-  package ds
  Definition Classes
    adam
-  package feature
-  package fragment
-  package read
-  package sequence
-  package variant
- ADAMContext
- ADAMSaveAnyArgs
- AvroGenomicDataset
- AvroReadGroupGenomicDataset
- DatasetBoundGenericGenomicDataset
- DatasetBoundGenomicDataset
- FullOuterShuffleRegionJoin
- GenericConverter
- GenericGenomicDataset
- GenomeBins
- GenomicBroadcast
- GenomicDataset
- GenomicDatasetConversion
- GenomicDatasetWithLineage
- GenomicPositionPartitioner
- GenomicRegionPartitioner
- InFormatter
- InFormatterCompanion
- InnerShuffleRegionJoin
- InnerShuffleRegionJoinAndGroupByLeft
- InnerTreeRegionJoin
- InnerTreeRegionJoinAndGroupByRight
- LeftOuterShuffleRegionJoin
- LeftOuterShuffleRegionJoinAndGroupByLeft
- MultisampleAvroGenomicDataset
- MultisampleGenomicDataset
- OutFormatter
- RDDBoundGenericGenomicDataset
- ReferencePartitioner
- RegionJoin
- RightOuterShuffleRegionJoinAndGroupByLeft
- RightOuterTreeRegionJoin
- RightOuterTreeRegionJoinAndGroupByRight
- ShuffleRegionJoin
- SortedIntervalPartitionJoinWithVictims
- TreeRegionJoin
- VictimlessSortedIntervalPartitionJoin
-  package io
  Definition Classes
    adam
-  package models
  Definition Classes
    adam
-  package projections
  Definition Classes
    adam
-  package rich
  Definition Classes
    adam
-  package serialization
  Definition Classes
    adam
-  package sql
  Definition Classes
    adam
-  package util
  Definition Classes
    adam

p

org.bdgenomics.adam

# ds 

#### package ds

 
Ordering

1. Alphabetic

Visibility

1. Public
2. All

### Type Members

1.  class ADAMContext extends Serializable with Logging

   The ADAMContext provides functions on top of a SparkContext for loading genomic data.

2.  trait ADAMSaveAnyArgs extends SaveArgs

   Argument configuration for saving any output format.

3.  abstract class AvroGenomicDataset[T, U <: Product, V <: AvroGenomicDataset[T, U, V]] extends GenomicDataset[T, U, V]

   An abstract class that extends GenomicDataset and where the underlying data are Avro IndexedRecords.

   An abstract class that extends GenomicDataset and where the underlying data are Avro IndexedRecords. This abstract class provides methods for saving Avro to Parquet.

4.  abstract class AvroReadGroupGenomicDataset[T, U <: Product, V <: AvroReadGroupGenomicDataset[T, U, V]] extends AvroGenomicDataset[T, U, V] with GenomicDatasetWithLineage[T, U, V]

   An abstract class describing a GenomicDataset where:

   An abstract class describing a GenomicDataset where:

   * The data are Avro IndexedRecords. * The data are associated to read groups (i.e., they are reads or fragments).

5.  case class DatasetBoundGenericGenomicDataset[T, U <: Product](dataset: Dataset[U], references: SequenceDictionary, converter: GenericConverter[T, U], tagHolder: TagHolder[T, U]) extends GenericGenomicDataset[T, U] with Product with Serializable
6.  trait DatasetBoundGenomicDataset[T, U <: Product, V <: GenomicDataset[T, U, V]] extends GenomicDataset[T, U, V]

   A trait describing a GenomicDataset that is physically backed by a Dataset.

7.  case class FullOuterShuffleRegionJoin[T, U](leftRdd: RDD[(ReferenceRegion, T)], rightRdd: RDD[(ReferenceRegion, U)])(implicit evidence$11: ClassTag[T], evidence$12: ClassTag[U]) extends ShuffleRegionJoin[T, U, Option[T], Option[U]] with SortedIntervalPartitionJoinWithVictims[T, U, Option[T], Option[U]] with Product with Serializable
8.  case class GenericConverter[T, U] extends Product with Serializable
9.  sealed abstract class GenericGenomicDataset[T, U <: Product] extends GenomicDataset[T, U, GenericGenomicDataset[T, U]]
10.  case class GenomeBins(binSize: Long, seqLengths: Map[String, Long]) extends Serializable with Product

    Partition a genome into a set of bins.

    Partition a genome into a set of bins.

    Note that this class will not tolerate invalid input, so filter in advance if you use it.

    binSize

      The size of each bin in nucleotides

    seqLengths

      A map containing the length of each contig

11.  case class GenomicBroadcast[T, U <: Product, V <: GenomicDataset[T, U, V]] extends Product with Serializable
12.  trait GenomicDataset[T, U <: Product, V <: GenomicDataset[T, U, V]] extends Logging

    A trait that wraps an RDD or Dataset of genomic data with helpful metadata.

    A trait that wraps an RDD or Dataset of genomic data with helpful metadata.

    T

      The type of the data in the wrapped RDD or Dataset.

    U

      The type of this GenomicDataset.

13.  trait GenomicDatasetConversion[T, U <: Product, V <: GenomicDataset[T, U, V], X, Y <: Product, Z <: GenomicDataset[X, Y, Z]] extends Function2[V, Dataset[Y], Z]
14.  trait GenomicDatasetWithLineage[T, U <: Product, V <: GenomicDatasetWithLineage[T, U, V]] extends GenomicDataset[T, U, V]
15.  case class GenomicPositionPartitioner(numParts: Int, seqLengths: Map[String, Long]) extends Partitioner with Logging with Product with Serializable

    GenomicPositionPartitioner partitions ReferencePosition objects into separate, spatially-coherent regions of the genome.

    GenomicPositionPartitioner partitions ReferencePosition objects into separate, spatially-coherent regions of the genome.

    This can be used to organize genomic data for computation that is spatially distributed (e.g. GATK and Queue's "scatter-and-gather" for locus-parallelizable walkers).

    numParts

      The number of equally-sized regions into which the total genomic space is partitioned; the total number of partitions is numParts + 1, with the "+1" resulting from one extra partition that is used to capture null or UNMAPPED values of the ReferencePosition type.

    seqLengths

      a map relating sequence-name to length and indicating the set and length of all extant sequences in the genome.

16.  case class GenomicRegionPartitioner(partitionSize: Long, seqLengths: Map[String, Long], start: Boolean = true) extends Partitioner with Logging with Product with Serializable

    A partitioner for ReferenceRegion-keyed data.

    A partitioner for ReferenceRegion-keyed data.

    partitionSize

      The number of bases per partition.

    seqLengths

      A map between contig names and contig lengths.

    start

      If true, use the start position (instead of the end position) to decide which partition a key belongs to.

17.  trait InFormatter[T, U <: Product, V <: GenomicDataset[T, U, V], W <: InFormatter[T, U, V, W]] extends Serializable

    Formats data going into a pipe to an invoked process.

    Formats data going into a pipe to an invoked process.

    T

      The type of records being formatted.

18.  trait InFormatterCompanion[T, U <: Product, V <: GenomicDataset[T, U, V], W <: InFormatter[T, U, V, W]] extends AnyRef

    A trait for singleton objects that build an InFormatter from a GenomicDataset.

    A trait for singleton objects that build an InFormatter from a GenomicDataset.

    Often, when creating an outputstream, we need to add metadata to the output that is not attached to individual records. An example of this is writing a header with contig/read group/format info, as is done with SAM/BAM/VCF.

    T

      The type of the records this InFormatter writes out.

    U

      The type of the GenomicDataset this companion object understands.

    V

      The type of InFormatter this companion object creates.

19.  case class InnerShuffleRegionJoin[T, U](leftRdd: RDD[(ReferenceRegion, T)], rightRdd: RDD[(ReferenceRegion, U)])(implicit evidence$3: ClassTag[T], evidence$4: ClassTag[U]) extends ShuffleRegionJoin[T, U, T, U] with VictimlessSortedIntervalPartitionJoin[T, U, T, U] with Product with Serializable
20.  case class InnerShuffleRegionJoinAndGroupByLeft[T, U](leftRdd: RDD[(ReferenceRegion, T)], rightRdd: RDD[(ReferenceRegion, U)])(implicit evidence$5: ClassTag[T], evidence$6: ClassTag[U]) extends ShuffleRegionJoin[T, U, T, Iterable[U]] with VictimlessSortedIntervalPartitionJoin[T, U, T, Iterable[U]] with Product with Serializable
21.  case class InnerTreeRegionJoin[T, U]()(implicit evidence$1: ClassTag[T], evidence$2: ClassTag[U]) extends RegionJoin[T, U, T, U] with TreeRegionJoin[T, U, T, U] with Product with Serializable

    Implements an inner region join where the left side of the join is broadcast.

22.  case class InnerTreeRegionJoinAndGroupByRight[T, U]()(implicit evidence$5: ClassTag[T], evidence$6: ClassTag[U]) extends RegionJoin[T, U, Iterable[T], U] with TreeRegionJoin[T, U, Iterable[T], U] with Product with Serializable

    Performs an inner region join, followed logically by grouping by the right value.

    Performs an inner region join, followed logically by grouping by the right value. This is implemented without any shuffling; the join naturally returns values on the left grouped by the right value.

23.  case class LeftOuterShuffleRegionJoin[T, U](leftRdd: RDD[(ReferenceRegion, T)], rightRdd: RDD[(ReferenceRegion, U)])(implicit evidence$7: ClassTag[T], evidence$8: ClassTag[U]) extends ShuffleRegionJoin[T, U, T, Option[U]] with VictimlessSortedIntervalPartitionJoin[T, U, T, Option[U]] with Product with Serializable
24.  case class LeftOuterShuffleRegionJoinAndGroupByLeft[T, U](leftRdd: RDD[(ReferenceRegion, T)], rightRdd: RDD[(ReferenceRegion, U)])(implicit evidence$9: ClassTag[T], evidence$10: ClassTag[U]) extends ShuffleRegionJoin[T, U, T, Iterable[U]] with VictimlessSortedIntervalPartitionJoin[T, U, T, Iterable[U]] with Product with Serializable
25.  abstract class MultisampleAvroGenomicDataset[T, U <: Product, V <: MultisampleAvroGenomicDataset[T, U, V]] extends AvroGenomicDataset[T, U, V] with MultisampleGenomicDataset[T, U, V]

    An abstract class that extends the MultisampleGenomicDataset trait, where the data are Avro IndexedRecords.

26.  trait MultisampleGenomicDataset[T, U <: Product, V <: MultisampleGenomicDataset[T, U, V]] extends GenomicDataset[T, U, V]

    A trait describing a GenomicDataset with data from multiple samples.

27.  trait OutFormatter[T] extends Serializable

    Deserializes data coming out of a pipe from an invoked process.

    Deserializes data coming out of a pipe from an invoked process.

    T

      The type of records being formatted.

28.  case class RDDBoundGenericGenomicDataset[T, U <: Product](rdd: RDD[T], references: SequenceDictionary, converter: GenericConverter[T, U], tagHolder: TagHolder[T, U], optPartitionMap: Option[Array[Option[(ReferenceRegion, ReferenceRegion)]]] = None) extends GenericGenomicDataset[T, U] with Product with Serializable
29.  case class ReferencePartitioner(sd: SequenceDictionary) extends Partitioner with Product with Serializable

    Repartitions objects that are keyed by a ReferencePosition or ReferenceRegion into a single partition per contig.

30.  abstract class RegionJoin[T, U, RT, RU] extends Serializable

    A trait describing a join in the genomic coordinate space between two RDDs where the values are keyed by a ReferenceRegion.

    A trait describing a join in the genomic coordinate space between two RDDs where the values are keyed by a ReferenceRegion.

    T

      The type of the left RDD.

    U

      The type of the right RDD.

    RT

      The type of data yielded by the left RDD at the output of the join. This may not match T if the join is an outer join, etc.

    RU

      The type of data yielded by the right RDD at the output of the join.

31.  case class RightOuterShuffleRegionJoinAndGroupByLeft[T, U](leftRdd: RDD[(ReferenceRegion, T)], rightRdd: RDD[(ReferenceRegion, U)])(implicit evidence$13: ClassTag[T], evidence$14: ClassTag[U]) extends ShuffleRegionJoin[T, U, Option[T], Iterable[U]] with SortedIntervalPartitionJoinWithVictims[T, U, Option[T], Iterable[U]] with Product with Serializable
32.  case class RightOuterTreeRegionJoin[T, U]()(implicit evidence$3: ClassTag[T], evidence$4: ClassTag[U]) extends RegionJoin[T, U, Option[T], U] with TreeRegionJoin[T, U, Option[T], U] with Product with Serializable

    Implements a right outer region join where the left side of the join is broadcast.

33.  case class RightOuterTreeRegionJoinAndGroupByRight[T, U]()(implicit evidence$7: ClassTag[T], evidence$8: ClassTag[U]) extends RegionJoin[T, U, Iterable[T], U] with TreeRegionJoin[T, U, Iterable[T], U] with Product with Serializable

    Performs a right outer region join, followed logically by grouping by the right value.

    Performs a right outer region join, followed logically by grouping by the right value. This is implemented without any shuffling; the join naturally returns values on the left grouped by the right value. In this implementation, empty collections on the left side of the join are kept.

34.  sealed abstract class ShuffleRegionJoin[T, U, RT, RU] extends RegionJoin[T, U, RT, RU]

    A trait describing join implementations that are based on a sort-merge join.

    A trait describing join implementations that are based on a sort-merge join.

    T

      The type of the left RDD.

    U

      The type of the right RDD.

    RT

      The type of data yielded by the left RDD at the output of the join. This may not match T if the join is an outer join, etc.

    RU

      The type of data yielded by the right RDD at the output of the join.

35.  sealed trait SortedIntervalPartitionJoinWithVictims[T, U, RT, RU] extends ShuffleRegionJoin[T, U, RT, RU]
36.  trait TreeRegionJoin[T, U, RT, RU] extends RegionJoin[T, U, RT, RU]

    Implements a shuffle free (broadcast) region join.

    Implements a shuffle free (broadcast) region join.

    The broadcast values are stored in a sorted array. It was going to be an ensemble of interval trees, but, that didn't work out.

37.  sealed trait VictimlessSortedIntervalPartitionJoin[T, U, RT, RU] extends ShuffleRegionJoin[T, U, RT, RU]

### Value Members

1.  object ADAMContext extends Serializable

   This singleton provides an implicit conversion from a SparkContext to the ADAMContext, as well as implicit functions for the Pipe API.

2.  object GenomicPositionPartitioner extends Serializable

   Helper for creating genomic position partitioners.

3.  object GenomicRegionPartitioner extends Serializable

   Helper object for creating GenomicRegionPartitioners.

### Ungrouped