Class

org.bdgenomics.adam.rdd.contig

RDDBoundNucleotideContigFragmentDataset

Related Doc: package contig

Permalink

case class RDDBoundNucleotideContigFragmentDataset extends NucleotideContigFragmentDataset with Product with Serializable

A wrapper class for RDD[NucleotideContigFragment].

Linear Supertypes
Serializable, Serializable, Product, Equals, NucleotideContigFragmentDataset, AvroGenomicDataset[NucleotideContigFragment, NucleotideContigFragment, NucleotideContigFragmentDataset], GenomicDataset[NucleotideContigFragment, NucleotideContigFragment, NucleotideContigFragmentDataset], Logging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RDDBoundNucleotideContigFragmentDataset
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. NucleotideContigFragmentDataset
  7. AvroGenomicDataset
  8. GenomicDataset
  9. Logging
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addSequence(sequenceToAdd: SequenceRecord): NucleotideContigFragmentDataset

    Permalink

    Appends metadata for a single sequence to the current genomic dataset.

    Appends metadata for a single sequence to the current genomic dataset.

    sequenceToAdd

    The sequence to add.

    returns

    Returns a new GenomicDataset with this sequence appended.

    Definition Classes
    GenomicDataset
  5. def addSequences(sequencesToAdd: SequenceDictionary): NucleotideContigFragmentDataset

    Permalink

    Appends sequence metadata to the current genomic dataset.

    Appends sequence metadata to the current genomic dataset.

    sequencesToAdd

    The new sequences to append.

    returns

    Returns a new GenomicDataset with the sequences appended.

    Definition Classes
    GenomicDataset
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def broadcast()(implicit tTag: ClassTag[NucleotideContigFragment]): GenomicBroadcast[NucleotideContigFragment, NucleotideContigFragment, NucleotideContigFragmentDataset]

    Permalink
    Definition Classes
    GenomicDataset
  8. def broadcastRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z])(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], txTag: ClassTag[(NucleotideContigFragment, X)], uyTag: scala.reflect.api.JavaUniverse.TypeTag[(NucleotideContigFragment, Y)]): GenericGenomicDataset[(NucleotideContigFragment, X), (NucleotideContigFragment, Y)]

    Permalink

    Performs a broadcast inner join between this genomic dataset and another genomic dataset.

    Performs a broadcast inner join between this genomic dataset and another genomic dataset.

    In a broadcast join, the left genomic dataset (this genomic dataset) is collected to the driver, and broadcast to all the nodes in the cluster. The key equality function used for this join is the reference region overlap function. Since this is an inner join, all values who do not overlap a value from the other genomic dataset are dropped.

    genomicDataset

    The right genomic dataset in the join.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.

    Definition Classes
    GenomicDataset
    See also

    broadcastRegionJoinAgainst

  9. def broadcastRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Long)(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], txTag: ClassTag[(NucleotideContigFragment, X)], uyTag: scala.reflect.api.JavaUniverse.TypeTag[(NucleotideContigFragment, Y)]): GenericGenomicDataset[(NucleotideContigFragment, X), (NucleotideContigFragment, Y)]

    Permalink

    Performs a broadcast inner join between this genomic dataset and another genomic dataset.

    Performs a broadcast inner join between this genomic dataset and another genomic dataset.

    In a broadcast join, the left genomic dataset (this genomic dataset) is collected to the driver, and broadcast to all the nodes in the cluster. The key equality function used for this join is the reference region overlap function. Since this is an inner join, all values who do not overlap a value from the other genomic dataset are dropped.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.

    Definition Classes
    GenomicDataset
    See also

    broadcastRegionJoinAgainst

  10. def broadcastRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Integer): GenericGenomicDataset[(NucleotideContigFragment, X), (NucleotideContigFragment, Y)]

    Permalink

    (Java-specific) Performs a broadcast inner join between this genomic dataset and another genomic dataset.

    (Java-specific) Performs a broadcast inner join between this genomic dataset and another genomic dataset.

    In a broadcast join, the left genomic dataset (this genomic dataset) is collected to the driver, and broadcast to all the nodes in the cluster. The key equality function used for this join is the reference region overlap function. Since this is an inner join, all values who do not overlap a value from the other genomic dataset are dropped.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.

    Definition Classes
    GenomicDataset
  11. def broadcastRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Double): GenericGenomicDataset[(NucleotideContigFragment, X), (NucleotideContigFragment, Y)]

    Permalink

    (R-specific) Performs a broadcast inner join between this genomic dataset and another genomic dataset.

    (R-specific) Performs a broadcast inner join between this genomic dataset and another genomic dataset.

    In a broadcast join, the left genomic dataset (this genomic dataset) is collected to the driver, and broadcast to all the nodes in the cluster. The key equality function used for this join is the reference region overlap function. Since this is an inner join, all values who do not overlap a value from the other genomic dataset are dropped.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.

    Definition Classes
    GenomicDataset
  12. def broadcastRegionJoinAgainst[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](broadcast: GenomicBroadcast[X, Y, Z])(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], uyTag: scala.reflect.api.JavaUniverse.TypeTag[(Y, NucleotideContigFragment)]): GenericGenomicDataset[(X, NucleotideContigFragment), (Y, NucleotideContigFragment)]

    Permalink

    Performs a broadcast inner join between this genomic dataset and data that has been broadcast.

    Performs a broadcast inner join between this genomic dataset and data that has been broadcast.

    In a broadcast join, the left side of the join (broadcastTree) is broadcast to to all the nodes in the cluster. The key equality function used for this join is the reference region overlap function. Since this is an inner join, all values who do not overlap a value from the other genomic dataset are dropped. As compared to broadcastRegionJoin, this function allows the broadcast object to be reused across multiple joins.

    broadcast

    The data on the left side of the join.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.

    Definition Classes
    GenomicDataset
    Note

    This function differs from other region joins as it treats the calling genomic dataset as the right side of the join, and not the left.

    See also

    broadcastRegionJoin

  13. def broadcastRegionJoinAgainstAndGroupByRight[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](broadcast: GenomicBroadcast[X, Y, Z])(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], syuTag: scala.reflect.api.JavaUniverse.TypeTag[(Seq[Y], NucleotideContigFragment)]): GenericGenomicDataset[(Iterable[X], NucleotideContigFragment), (Seq[Y], NucleotideContigFragment)]

    Permalink

    Performs a broadcast inner join between this genomic dataset and another genomic dataset.

    Performs a broadcast inner join between this genomic dataset and another genomic dataset.

    In a broadcast join, the left side of the join (broadcastTree) is broadcast to to all the nodes in the cluster. The key equality function used for this join is the reference region overlap function. Since this is an inner join, all values who do not overlap a value from the other genomic dataset are dropped. As compared to broadcastRegionJoin, this function allows the broadcast object to be reused across multiple joins.

    broadcast

    The data on the left side of the join.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.

    Definition Classes
    GenomicDataset
    Note

    This function differs from other region joins as it treats the calling genomic dataset as the right side of the join, and not the left.

    See also

    broadcastRegionJoinAndGroupByRight

  14. def broadcastRegionJoinAndGroupByRight[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z])(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], itxTag: ClassTag[(Iterable[NucleotideContigFragment], X)], iuyTag: scala.reflect.api.JavaUniverse.TypeTag[(Seq[NucleotideContigFragment], Y)]): GenericGenomicDataset[(Iterable[NucleotideContigFragment], X), (Seq[NucleotideContigFragment], Y)]

    Permalink

    Performs a broadcast inner join between this genomic dataset and another genomic dataset.

    Performs a broadcast inner join between this genomic dataset and another genomic dataset.

    In a broadcast join, the left genomic dataset (this genomic dataset) is collected to the driver, and broadcast to all the nodes in the cluster. The key equality function used for this join is the reference region overlap function. Since this is an inner join, all values who do not overlap a value from the other genomic dataset are dropped.

    genomicDataset

    The right genomic dataset in the join.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.

    Definition Classes
    GenomicDataset
    See also

    broadcastRegionJoinAgainstAndGroupByRight

  15. def broadcastRegionJoinAndGroupByRight[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Long)(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], itxTag: ClassTag[(Iterable[NucleotideContigFragment], X)], iuyTag: scala.reflect.api.JavaUniverse.TypeTag[(Seq[NucleotideContigFragment], Y)]): GenericGenomicDataset[(Iterable[NucleotideContigFragment], X), (Seq[NucleotideContigFragment], Y)]

    Permalink

    Performs a broadcast inner join between this genomic dataset and another genomic dataset.

    Performs a broadcast inner join between this genomic dataset and another genomic dataset.

    In a broadcast join, the left genomic dataset (this genomic dataset) is collected to the driver, and broadcast to all the nodes in the cluster. The key equality function used for this join is the reference region overlap function. Since this is an inner join, all values who do not overlap a value from the other genomic dataset are dropped.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.

    Definition Classes
    GenomicDataset
    See also

    broadcastRegionJoinAgainstAndGroupByRight

  16. def broadcastRegionJoinAndGroupByRight[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Integer): GenericGenomicDataset[(Iterable[NucleotideContigFragment], X), (Seq[NucleotideContigFragment], Y)]

    Permalink

    (Java-specific) Performs a broadcast inner join between this genomic dataset and another genomic dataset.

    (Java-specific) Performs a broadcast inner join between this genomic dataset and another genomic dataset.

    In a broadcast join, the left genomic dataset (this genomic dataset) is collected to the driver, and broadcast to all the nodes in the cluster. The key equality function used for this join is the reference region overlap function. Since this is an inner join, all values who do not overlap a value from the other genomic dataset are dropped.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.

    Definition Classes
    GenomicDataset
    See also

    broadcastRegionJoinAgainstAndGroupByRight

  17. def broadcastRegionJoinAndGroupByRight[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Double): GenericGenomicDataset[(Iterable[NucleotideContigFragment], X), (Seq[NucleotideContigFragment], Y)]

    Permalink

    (R-specific) Performs a broadcast inner join between this genomic dataset and another genomic dataset.

    (R-specific) Performs a broadcast inner join between this genomic dataset and another genomic dataset.

    In a broadcast join, the left genomic dataset (this genomic dataset) is collected to the driver, and broadcast to all the nodes in the cluster. The key equality function used for this join is the reference region overlap function. Since this is an inner join, all values who do not overlap a value from the other genomic dataset are dropped.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.

    Definition Classes
    GenomicDataset
    See also

    broadcastRegionJoinAgainstAndGroupByRight

  18. def buildTree(rdd: RDD[(ReferenceRegion, NucleotideContigFragment)])(implicit tTag: ClassTag[NucleotideContigFragment]): IntervalArray[ReferenceRegion, NucleotideContigFragment]

    Permalink
    Attributes
    protected
    Definition Classes
    NucleotideContigFragmentDatasetGenomicDataset
  19. def cache(): NucleotideContigFragmentDataset

    Permalink

    Caches underlying RDD in memory.

    Caches underlying RDD in memory.

    returns

    Cached GenomicDataset.

    Definition Classes
    GenomicDataset
  20. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. def countKmers(kmerLength: Integer): JavaRDD[(String, Long)]

    Permalink

    (Java-specific) Counts the k-mers contained in a FASTA contig.

    (Java-specific) Counts the k-mers contained in a FASTA contig.

    kmerLength

    The length of k-mers to count.

    returns

    Returns an RDD containing k-mer/count pairs.

    Definition Classes
    NucleotideContigFragmentDataset
  22. def countKmers(kmerLength: Int): RDD[(String, Long)]

    Permalink

    (Scala-specific) Counts the k-mers contained in a FASTA contig.

    (Scala-specific) Counts the k-mers contained in a FASTA contig.

    kmerLength

    The length of k-mers to count.

    returns

    Returns an RDD containing k-mer/count pairs.

    Definition Classes
    NucleotideContigFragmentDataset
  23. lazy val dataset: Dataset[NucleotideContigFragment]

    Permalink

    A SQL Dataset of contig fragments.

    A SQL Dataset of contig fragments.

    Definition Classes
    RDDBoundNucleotideContigFragmentDatasetGenomicDataset
  24. def debug(mkr: Marker, msg: ⇒ Any, t: ⇒ Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  25. def debug(msg: ⇒ Any, t: ⇒ Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  26. def debug(msg: ⇒ Any): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  27. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. def error(mkr: Marker, msg: ⇒ Any, t: ⇒ Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  29. def error(msg: ⇒ Any, t: ⇒ Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  30. def error(msg: ⇒ Any): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  31. def extract(region: ReferenceRegion): String

    Permalink

    From a set of contigs, returns the base sequence that corresponds to a region of the reference.

    From a set of contigs, returns the base sequence that corresponds to a region of the reference.

    region

    Reference region over which to get sequence.

    returns

    String of bases corresponding to reference sequence.

    Definition Classes
    NucleotideContigFragmentDataset
    Exceptions thrown

    UnsupportedOperationException Throws exception if query region is not found.

  32. def extractRegions(regions: Iterable[ReferenceRegion]): RDD[(ReferenceRegion, String)]

    Permalink

    (Scala-specific) From a set of contigs, returns a list of sequences based on reference regions provided.

    (Scala-specific) From a set of contigs, returns a list of sequences based on reference regions provided.

    regions

    Reference regions over which to get sequences.

    returns

    RDD[(ReferenceRegion, String)] of region -> sequence pairs.

    Definition Classes
    NucleotideContigFragmentDataset
  33. def extractRegions(regions: List[ReferenceRegion]): JavaRDD[(ReferenceRegion, String)]

    Permalink

    (Java-specific) From a set of contigs, returns a list of sequences based on reference regions provided.

    (Java-specific) From a set of contigs, returns a list of sequences based on reference regions provided.

    regions

    List of Reference regions over which to get sequences.

    returns

    JavaRDD[(ReferenceRegion, String)] of region -> sequence pairs.

    Definition Classes
    NucleotideContigFragmentDataset
  34. def filterByOverlappingRegion(query: ReferenceRegion): NucleotideContigFragmentDataset

    Permalink

    Runs a filter that selects data in the underlying RDD that overlaps a single genomic region.

    Runs a filter that selects data in the underlying RDD that overlaps a single genomic region.

    query

    The region to query for.

    returns

    Returns a new GenomicDataset containing only data that overlaps the query region.

    Definition Classes
    GenomicDataset
  35. def filterByOverlappingRegions(querys: Iterable[ReferenceRegion]): NucleotideContigFragmentDataset

    Permalink

    (Java-specific) Runs a filter that selects data in the underlying RDD that overlaps several genomic regions.

    (Java-specific) Runs a filter that selects data in the underlying RDD that overlaps several genomic regions.

    querys

    The regions to query for.

    returns

    Returns a new GenomicDataset containing only data that overlaps the querys region.

    Definition Classes
    GenomicDataset
  36. def filterByOverlappingRegions(querys: Iterable[ReferenceRegion]): NucleotideContigFragmentDataset

    Permalink

    (Scala-specific) Runs a filter that selects data in the underlying RDD that overlaps several genomic regions.

    (Scala-specific) Runs a filter that selects data in the underlying RDD that overlaps several genomic regions.

    querys

    The regions to query for.

    returns

    Returns a new GenomicDataset containing only data that overlaps the querys region.

    Definition Classes
    GenomicDataset
  37. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  38. def flankAdjacentFragments(flankLength: Int): NucleotideContigFragmentDataset

    Permalink

    (Scala-specific) For all adjacent records in the genomic dataset, we extend the records so that the adjacent records now overlap by _n_ bases, where _n_ is the flank length.

    (Scala-specific) For all adjacent records in the genomic dataset, we extend the records so that the adjacent records now overlap by _n_ bases, where _n_ is the flank length.

    flankLength

    The length to extend adjacent records by.

    returns

    Returns the genomic dataset, with all adjacent fragments extended with flanking sequence.

    Definition Classes
    NucleotideContigFragmentDataset
  39. def flankAdjacentFragments(flankLength: Integer): NucleotideContigFragmentDataset

    Permalink

    (Java-specific) For all adjacent records in the genomic dataset, we extend the records so that the adjacent records now overlap by _n_ bases, where _n_ is the flank length.

    (Java-specific) For all adjacent records in the genomic dataset, we extend the records so that the adjacent records now overlap by _n_ bases, where _n_ is the flank length.

    flankLength

    The length to extend adjacent records by.

    returns

    Returns the genomic dataset, with all adjacent fragments extended with flanking sequence.

    Definition Classes
    NucleotideContigFragmentDataset
  40. def flattenRddByRegions(): RDD[(ReferenceRegion, NucleotideContigFragment)]

    Permalink
    Attributes
    protected
    Definition Classes
    GenomicDataset
  41. def fullOuterShuffleRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z])(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], otoxTag: ClassTag[(Option[NucleotideContigFragment], Option[X])], ouoyTag: scala.reflect.api.JavaUniverse.TypeTag[(Option[NucleotideContigFragment], Option[Y])]): GenericGenomicDataset[(Option[NucleotideContigFragment], Option[X]), (Option[NucleotideContigFragment], Option[Y])]

    Permalink

    Performs a sort-merge full outer join between this genomic dataset and another genomic dataset.

    Performs a sort-merge full outer join between this genomic dataset and another genomic dataset.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is a full outer join, if a value from either genomic dataset does not overlap any values in the other genomic dataset, it will be paired with a None in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and values that did not overlap will be paired with a None.

    Definition Classes
    GenomicDataset
  42. def fullOuterShuffleRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Long)(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], otoxTag: ClassTag[(Option[NucleotideContigFragment], Option[X])], ouoyTag: scala.reflect.api.JavaUniverse.TypeTag[(Option[NucleotideContigFragment], Option[Y])]): GenericGenomicDataset[(Option[NucleotideContigFragment], Option[X]), (Option[NucleotideContigFragment], Option[Y])]

    Permalink

    Performs a sort-merge full outer join between this genomic dataset and another genomic dataset.

    Performs a sort-merge full outer join between this genomic dataset and another genomic dataset.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is a full outer join, if a value from either genomic dataset does not overlap any values in the other genomic dataset, it will be paired with a None in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and values that did not overlap will be paired with a None.

    Definition Classes
    GenomicDataset
  43. def fullOuterShuffleRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Integer): GenericGenomicDataset[(Option[NucleotideContigFragment], Option[X]), (Option[NucleotideContigFragment], Option[Y])]

    Permalink

    (Python-specific) Performs a sort-merge full outer join between this genomic dataset and another genomic dataset.

    (Python-specific) Performs a sort-merge full outer join between this genomic dataset and another genomic dataset.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is a full outer join, if a value from either genomic dataset does not overlap any values in the other genomic dataset, it will be paired with a None in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and values that did not overlap will be paired with a None.

    Definition Classes
    GenomicDataset
  44. def fullOuterShuffleRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Double): GenericGenomicDataset[(Option[NucleotideContigFragment], Option[X]), (Option[NucleotideContigFragment], Option[Y])]

    Permalink

    (R-specific) Performs a sort-merge full outer join between this genomic dataset and another genomic dataset.

    (R-specific) Performs a sort-merge full outer join between this genomic dataset and another genomic dataset.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is a full outer join, if a value from either genomic dataset does not overlap any values in the other genomic dataset, it will be paired with a None in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and values that did not overlap will be paired with a None.

    Definition Classes
    GenomicDataset
  45. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  46. def getReferenceRegions(elem: NucleotideContigFragment): Seq[ReferenceRegion]

    Permalink

    elem

    Fragment to extract a region from.

    returns

    If a fragment is aligned to a reference location, returns a single reference region. If the fragment start position and name is not defined, returns no regions.

    Attributes
    protected
    Definition Classes
    NucleotideContigFragmentDatasetGenomicDataset
  47. def info(mkr: Marker, msg: ⇒ Any, t: ⇒ Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  48. def info(msg: ⇒ Any, t: ⇒ Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  49. def info(msg: ⇒ Any): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  50. def isDebugEnabled: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  51. def isErrorEnabled: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  52. def isInfoEnabled: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  53. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  54. def isSorted: Boolean

    Permalink
    Definition Classes
    GenomicDataset
  55. def isTraceEnabled: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  56. def isWarnEnabled: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  57. lazy val jrdd: JavaRDD[NucleotideContigFragment]

    Permalink

    The underlying RDD of genomic data, as a JavaRDD.

    The underlying RDD of genomic data, as a JavaRDD.

    Definition Classes
    GenomicDataset
  58. def leftOuterShuffleRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z])(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], toxTag: ClassTag[(NucleotideContigFragment, Option[X])], uoyTag: scala.reflect.api.JavaUniverse.TypeTag[(NucleotideContigFragment, Option[Y])]): GenericGenomicDataset[(NucleotideContigFragment, Option[X]), (NucleotideContigFragment, Option[Y])]

    Permalink

    Performs a sort-merge left outer join between this genomic dataset and another genomic dataset.

    Performs a sort-merge left outer join between this genomic dataset and another genomic dataset.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is a left outer join, all values in the right genomic dataset that do not overlap a value from the left genomic dataset are dropped. If a value from the left genomic dataset does not overlap any values in the right genomic dataset, it will be paired with a None in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the left genomic dataset that did not overlap a key in the right genomic dataset.

    Definition Classes
    GenomicDataset
  59. def leftOuterShuffleRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Long)(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], toxTag: ClassTag[(NucleotideContigFragment, Option[X])], uoyTag: scala.reflect.api.JavaUniverse.TypeTag[(NucleotideContigFragment, Option[Y])]): GenericGenomicDataset[(NucleotideContigFragment, Option[X]), (NucleotideContigFragment, Option[Y])]

    Permalink

    Performs a sort-merge left outer join between this genomic dataset and another genomic dataset.

    Performs a sort-merge left outer join between this genomic dataset and another genomic dataset.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is a left outer join, all values in the right genomic dataset that do not overlap a value from the left genomic dataset are dropped. If a value from the left genomic dataset does not overlap any values in the right genomic dataset, it will be paired with a None in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the left genomic dataset that did not overlap a key in the right genomic dataset.

    Definition Classes
    GenomicDataset
  60. def leftOuterShuffleRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Integer): GenericGenomicDataset[(NucleotideContigFragment, Option[X]), (NucleotideContigFragment, Option[Y])]

    Permalink

    (Java-specific) Performs a sort-merge left outer join between this genomic dataset and another genomic dataset.

    (Java-specific) Performs a sort-merge left outer join between this genomic dataset and another genomic dataset.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is a left outer join, all values in the right genomic dataset that do not overlap a value from the left genomic dataset are dropped. If a value from the left genomic dataset does not overlap any values in the right genomic dataset, it will be paired with a None in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the left genomic dataset that did not overlap a key in the right genomic dataset.

    Definition Classes
    GenomicDataset
  61. def leftOuterShuffleRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Double): GenericGenomicDataset[(NucleotideContigFragment, Option[X]), (NucleotideContigFragment, Option[Y])]

    Permalink

    (R-specific) Performs a sort-merge left outer join between this genomic dataset and another genomic dataset.

    (R-specific) Performs a sort-merge left outer join between this genomic dataset and another genomic dataset.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is a left outer join, all values in the right genomic dataset that do not overlap a value from the left genomic dataset are dropped. If a value from the left genomic dataset does not overlap any values in the right genomic dataset, it will be paired with a None in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the left genomic dataset that did not overlap a key in the right genomic dataset.

    Definition Classes
    GenomicDataset
  62. def leftOuterShuffleRegionJoinAndGroupByLeft[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z])(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], toxTag: ClassTag[(NucleotideContigFragment, Iterable[X])], uiyTag: scala.reflect.api.JavaUniverse.TypeTag[(NucleotideContigFragment, Seq[Y])]): GenericGenomicDataset[(NucleotideContigFragment, Iterable[X]), (NucleotideContigFragment, Seq[Y])]

    Permalink

    Performs a sort-merge left outer join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value.

    Performs a sort-merge left outer join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is a left outer join, all values in the right genomic dataset that do not overlap a value from the left genomic dataset are dropped. If a value from the left genomic dataset does not overlap any values in the right genomic dataset, it will be paired with an empty Iterable in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the left genomic dataset that did not overlap a key in the right genomic dataset.

    Definition Classes
    GenomicDataset
  63. def leftOuterShuffleRegionJoinAndGroupByLeft[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Long)(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], toxTag: ClassTag[(NucleotideContigFragment, Iterable[X])], uiyTag: scala.reflect.api.JavaUniverse.TypeTag[(NucleotideContigFragment, Seq[Y])]): GenericGenomicDataset[(NucleotideContigFragment, Iterable[X]), (NucleotideContigFragment, Seq[Y])]

    Permalink

    Performs a sort-merge left outer join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value.

    Performs a sort-merge left outer join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is a left outer join, all values in the right genomic dataset that do not overlap a value from the left genomic dataset are dropped. If a value from the left genomic dataset does not overlap any values in the right genomic dataset, it will be paired with an empty Iterable in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the left genomic dataset that did not overlap a key in the right genomic dataset.

    Definition Classes
    GenomicDataset
  64. def leftOuterShuffleRegionJoinAndGroupByLeft[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Integer): GenericGenomicDataset[(NucleotideContigFragment, Iterable[X]), (NucleotideContigFragment, Seq[Y])]

    Permalink

    (Java-specific) Performs a sort-merge left outer join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value.

    (Java-specific) Performs a sort-merge left outer join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is a left outer join, all values in the right genomic dataset that do not overlap a value from the left genomic dataset are dropped. If a value from the left genomic dataset does not overlap any values in the right genomic dataset, it will be paired with an empty Iterable in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the left genomic dataset that did not overlap a key in the right genomic dataset.

    Definition Classes
    GenomicDataset
  65. def leftOuterShuffleRegionJoinAndGroupByLeft[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Double): GenericGenomicDataset[(NucleotideContigFragment, Iterable[X]), (NucleotideContigFragment, Seq[Y])]

    Permalink

    (R-specific) Performs a sort-merge left outer join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value.

    (R-specific) Performs a sort-merge left outer join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is a left outer join, all values in the right genomic dataset that do not overlap a value from the left genomic dataset are dropped. If a value from the left genomic dataset does not overlap any values in the right genomic dataset, it will be paired with an empty Iterable in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the left genomic dataset that did not overlap a key in the right genomic dataset.

    Definition Classes
    GenomicDataset
  66. def logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  67. def loggerName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  68. def mergeFragments(): NucleotideContigFragmentDataset

    Permalink

    Merge fragments by contig name.

    Merge fragments by contig name.

    returns

    Returns a NucleotideContigFragmentDataset containing a single fragment per contig.

    Definition Classes
    NucleotideContigFragmentDataset
  69. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  70. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  71. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  72. val optPartitionMap: Option[Array[Option[(ReferenceRegion, ReferenceRegion)]]]

    Permalink
  73. def persist(sl: StorageLevel): NucleotideContigFragmentDataset

    Permalink

    Persists underlying RDD in memory or disk.

    Persists underlying RDD in memory or disk.

    sl

    new StorageLevel

    returns

    Persisted GenomicDataset.

    Definition Classes
    GenomicDataset
  74. def pipe[X, Y <: Product, Z <: GenomicDataset[X, Y, Z], W <: InFormatter[NucleotideContigFragment, NucleotideContigFragment, NucleotideContigFragmentDataset, W]](cmd: List[String], files: List[String], environment: Map[String, String], flankSize: Integer, tFormatter: Class[W], xFormatter: OutFormatter[X], convFn: Function2[NucleotideContigFragmentDataset, RDD[X], Z]): Z

    Permalink

    (Java/Python-specific) Pipes genomic data to a subprocess that runs in parallel using Spark.

    (Java/Python-specific) Pipes genomic data to a subprocess that runs in parallel using Spark.

    X

    The type of the record created by the piped command.

    Y

    A GenomicDataset containing X's.

    cmd

    Command to run.

    files

    Files to make locally available to the commands being run. Default is empty.

    environment

    A map containing environment variable/value pairs to set in the environment for the newly created process. Default is empty.

    flankSize

    Number of bases to flank each command invocation by.

    tFormatter

    Class of formatter for data going into pipe command.

    xFormatter

    Formatter for data coming out of the pipe command.

    convFn

    The conversion function used to build the final genomic dataset.

    returns

    Returns a new GenomicDataset of type Y.

    Definition Classes
    GenomicDataset
  75. def pipe[X, Y <: Product, Z <: GenomicDataset[X, Y, Z], W <: InFormatter[NucleotideContigFragment, NucleotideContigFragment, NucleotideContigFragmentDataset, W]](cmd: Seq[Any], files: Seq[Any], environment: Map[Any, Any], flankSize: Double, tFormatter: Class[W], xFormatter: OutFormatter[X], convFn: Function2[NucleotideContigFragmentDataset, RDD[X], Z]): Z

    Permalink

    (R-specific) Pipes genomic data to a subprocess that runs in parallel using Spark.

    (R-specific) Pipes genomic data to a subprocess that runs in parallel using Spark.

    X

    The type of the record created by the piped command.

    Y

    A GenomicDataset containing X's.

    cmd

    Command to run.

    files

    Files to make locally available to the commands being run. Default is empty.

    environment

    A map containing environment variable/value pairs to set in the environment for the newly created process. Default is empty.

    flankSize

    Number of bases to flank each command invocation by.

    tFormatter

    Class of formatter for data going into pipe command.

    xFormatter

    Formatter for data coming out of the pipe command.

    convFn

    The conversion function used to build the final genomic dataset.

    returns

    Returns a new GenomicDataset of type Y.

    Definition Classes
    GenomicDataset
  76. def pipe[X, Y <: Product, Z <: GenomicDataset[X, Y, Z], W <: InFormatter[NucleotideContigFragment, NucleotideContigFragment, NucleotideContigFragmentDataset, W]](cmd: Seq[String], files: Seq[String] = Seq.empty, environment: Map[String, String] = Map.empty, flankSize: Int = 0, optTimeout: Option[Int] = None)(implicit tFormatterCompanion: InFormatterCompanion[NucleotideContigFragment, NucleotideContigFragment, NucleotideContigFragmentDataset, W], xFormatter: OutFormatter[X], convFn: (NucleotideContigFragmentDataset, RDD[X]) ⇒ Z, tManifest: ClassTag[NucleotideContigFragment], xManifest: ClassTag[X]): Z

    Permalink

    (Scala-specific) Pipes genomic data to a subprocess that runs in parallel using Spark.

    (Scala-specific) Pipes genomic data to a subprocess that runs in parallel using Spark.

    Files are substituted in to the command with a $x syntax. E.g., to invoke a command that uses the first file from the files Seq, use $0. To access the path to the directory where the files are copied, use $root.

    Pipes require the presence of an InFormatterCompanion and an OutFormatter as implicit values. The InFormatterCompanion should be a singleton whose apply method builds an InFormatter given a specific type of GenomicDataset. The implicit InFormatterCompanion yields an InFormatter which is used to format the input to the pipe, and the implicit OutFormatter is used to parse the output from the pipe.

    X

    The type of the record created by the piped command.

    Y

    A GenomicDataset containing X's.

    cmd

    Command to run.

    files

    Files to make locally available to the commands being run. Default is empty.

    environment

    A map containing environment variable/value pairs to set in the environment for the newly created process. Default is empty.

    flankSize

    Number of bases to flank each command invocation by.

    optTimeout

    An optional parameter specifying how long to let a single partition run for, in seconds. If the partition times out, the partial results will be returned, and no exception will be logged. The partition will log that the command timed out.

    returns

    Returns a new GenomicDataset of type Y.

    Definition Classes
    GenomicDataset
  77. val productFn: (NucleotideContigFragment) ⇒ NucleotideContigFragment

    Permalink
    Attributes
    protected
    Definition Classes
    NucleotideContigFragmentDatasetGenomicDataset
  78. val rdd: RDD[NucleotideContigFragment]

    Permalink

    Underlying RDD

    Underlying RDD

    Definition Classes
    RDDBoundNucleotideContigFragmentDatasetGenomicDataset
  79. def replaceRdd(newRdd: RDD[NucleotideContigFragment], newPartitionMap: Option[Array[Option[(ReferenceRegion, ReferenceRegion)]]] = None): NucleotideContigFragmentDataset

    Permalink

    Replaces the underlying RDD with a new RDD.

    Replaces the underlying RDD with a new RDD.

    newRdd

    The RDD to use for the new NucleotideContigFragmentDataset.

    returns

    Returns a new NucleotideContigFragmentDataset where the underlying RDD has been replaced.

    Attributes
    protected
    Definition Classes
    NucleotideContigFragmentDatasetGenomicDataset
  80. def replaceSequences(newSequences: SequenceDictionary): NucleotideContigFragmentDataset

    Permalink

    Replaces the sequence dictionary attached to a GenomicDataset.

    Replaces the sequence dictionary attached to a GenomicDataset.

    newSequences

    The new sequence dictionary to attach.

    returns

    Returns a new GenomicDataset with the sequences replaced.

    Definition Classes
    RDDBoundNucleotideContigFragmentDatasetGenomicDataset
  81. def rightOuterBroadcastRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z])(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], otxTag: ClassTag[(Option[NucleotideContigFragment], X)], ouyTag: scala.reflect.api.JavaUniverse.TypeTag[(Option[NucleotideContigFragment], Y)]): GenericGenomicDataset[(Option[NucleotideContigFragment], X), (Option[NucleotideContigFragment], Y)]

    Permalink

    Performs a broadcast right outer join between this genomic dataset and another genomic dataset.

    Performs a broadcast right outer join between this genomic dataset and another genomic dataset.

    In a broadcast join, the left genomic dataset (this genomic dataset) is collected to the driver, and broadcast to all the nodes in the cluster. The key equality function used for this join is the reference region overlap function. Since this is a right outer join, all values in the left genomic dataset that do not overlap a value from the right genomic dataset are dropped. If a value from the right genomic dataset does not overlap any values in the left genomic dataset, it will be paired with a None in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the right genomic dataset that did not overlap a key in the left genomic dataset.

    Definition Classes
    GenomicDataset
    See also

    rightOuterBroadcastRegionJoin

  82. def rightOuterBroadcastRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Long)(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], otxTag: ClassTag[(Option[NucleotideContigFragment], X)], ouyTag: scala.reflect.api.JavaUniverse.TypeTag[(Option[NucleotideContigFragment], Y)]): GenericGenomicDataset[(Option[NucleotideContigFragment], X), (Option[NucleotideContigFragment], Y)]

    Permalink

    Performs a broadcast right outer join between this genomic dataset and another genomic dataset.

    Performs a broadcast right outer join between this genomic dataset and another genomic dataset.

    In a broadcast join, the left genomic dataset (this genomic dataset) is collected to the driver, and broadcast to all the nodes in the cluster. The key equality function used for this join is the reference region overlap function. Since this is a right outer join, all values in the left genomic dataset that do not overlap a value from the right genomic dataset are dropped. If a value from the right genomic dataset does not overlap any values in the left genomic dataset, it will be paired with a None in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the right genomic dataset that did not overlap a key in the left genomic dataset.

    Definition Classes
    GenomicDataset
    See also

    rightOuterBroadcastRegionJoin

  83. def rightOuterBroadcastRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Integer): GenericGenomicDataset[(Option[NucleotideContigFragment], X), (Option[NucleotideContigFragment], Y)]

    Permalink

    (Java-specific) Performs a broadcast right outer join between this genomic dataset and another genomic dataset.

    (Java-specific) Performs a broadcast right outer join between this genomic dataset and another genomic dataset.

    In a broadcast join, the left genomic dataset (this genomic dataset) is collected to the driver, and broadcast to all the nodes in the cluster. The key equality function used for this join is the reference region overlap function. Since this is a right outer join, all values in the left genomic dataset that do not overlap a value from the right genomic dataset are dropped. If a value from the right genomic dataset does not overlap any values in the left genomic dataset, it will be paired with a None in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the right genomic dataset that did not overlap a key in the left genomic dataset.

    Definition Classes
    GenomicDataset
  84. def rightOuterBroadcastRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Double): GenericGenomicDataset[(Option[NucleotideContigFragment], X), (Option[NucleotideContigFragment], Y)]

    Permalink

    (R-specific) Performs a broadcast right outer join between this genomic dataset and another genomic dataset.

    (R-specific) Performs a broadcast right outer join between this genomic dataset and another genomic dataset.

    In a broadcast join, the left genomic dataset (this genomic dataset) is collected to the driver, and broadcast to all the nodes in the cluster. The key equality function used for this join is the reference region overlap function. Since this is a right outer join, all values in the left genomic dataset that do not overlap a value from the right genomic dataset are dropped. If a value from the right genomic dataset does not overlap any values in the left genomic dataset, it will be paired with a None in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the right genomic dataset that did not overlap a key in the left genomic dataset.

    Definition Classes
    GenomicDataset
  85. def rightOuterBroadcastRegionJoinAgainst[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](broadcast: GenomicBroadcast[X, Y, Z])(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], oyuTag: scala.reflect.api.JavaUniverse.TypeTag[(Option[Y], NucleotideContigFragment)]): GenericGenomicDataset[(Option[X], NucleotideContigFragment), (Option[Y], NucleotideContigFragment)]

    Permalink

    Performs a broadcast right outer join between this genomic dataset and data that has been broadcast.

    Performs a broadcast right outer join between this genomic dataset and data that has been broadcast.

    In a broadcast join, the left side of the join (broadcastTree) is broadcast to to all the nodes in the cluster. The key equality function used for this join is the reference region overlap function. Since this is a right outer join, all values in the left table that do not overlap a value from the right genomic dataset are dropped. If a value from the right genomic dataset does not overlap any values in the left table, it will be paired with a None in the product of the join. As compared to broadcastRegionJoin, this function allows the broadcast object to be reused across multiple joins.

    broadcast

    The data on the left side of the join.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.

    Definition Classes
    GenomicDataset
    Note

    This function differs from other region joins as it treats the calling genomic dataset as the right side of the join, and not the left.

    See also

    rightOuterBroadcastRegionJoin

  86. def rightOuterBroadcastRegionJoinAgainstAndGroupByRight[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](broadcast: GenomicBroadcast[X, Y, Z])(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], syuTag: scala.reflect.api.JavaUniverse.TypeTag[(Seq[Y], NucleotideContigFragment)]): GenericGenomicDataset[(Iterable[X], NucleotideContigFragment), (Seq[Y], NucleotideContigFragment)]

    Permalink

    Performs a broadcast right outer join between this genomic dataset and another genomic dataset.

    Performs a broadcast right outer join between this genomic dataset and another genomic dataset.

    In a broadcast join, the left side of the join (broadcastTree) is broadcast to to all the nodes in the cluster. The key equality function used for this join is the reference region overlap function. Since this is a right outer join, all values in the left table that do not overlap a value from the right genomic dataset are dropped. If a value from the right genomic dataset does not overlap any values in the left table, it will be paired with a None in the product of the join. As compared to broadcastRegionJoin, this function allows the broadcast object to be reused across multiple joins.

    broadcast

    The data on the left side of the join.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.

    Definition Classes
    GenomicDataset
    Note

    This function differs from other region joins as it treats the calling genomic dataset as the right side of the join, and not the left.

    See also

    rightOuterBroadcastRegionJoinAndGroupByRight

  87. def rightOuterBroadcastRegionJoinAndGroupByRight[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z])(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], itxTag: ClassTag[(Iterable[NucleotideContigFragment], X)], iuyTag: scala.reflect.api.JavaUniverse.TypeTag[(Seq[NucleotideContigFragment], Y)]): GenericGenomicDataset[(Iterable[NucleotideContigFragment], X), (Seq[NucleotideContigFragment], Y)]

    Permalink

    Performs a broadcast right outer join between this genomic dataset and another genomic dataset.

    Performs a broadcast right outer join between this genomic dataset and another genomic dataset.

    In a broadcast join, the left side of the join (broadcastTree) is broadcast to to all the nodes in the cluster. The key equality function used for this join is the reference region overlap function. Since this is a right outer join, all values in the left genomic dataset that do not overlap a value from the right genomic dataset are dropped. If a value from the right genomic dataset does not overlap any values in the left genomic dataset, it will be paired with a None in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the right genomic dataset that did not overlap a key in the left genomic dataset.

    Definition Classes
    GenomicDataset
    See also

    rightOuterBroadcastRegionJoinAgainstAndGroupByRight

  88. def rightOuterBroadcastRegionJoinAndGroupByRight[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Long)(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], itxTag: ClassTag[(Iterable[NucleotideContigFragment], X)], iuyTag: scala.reflect.api.JavaUniverse.TypeTag[(Seq[NucleotideContigFragment], Y)]): GenericGenomicDataset[(Iterable[NucleotideContigFragment], X), (Seq[NucleotideContigFragment], Y)]

    Permalink

    Performs a broadcast right outer join between this genomic dataset and another genomic dataset.

    Performs a broadcast right outer join between this genomic dataset and another genomic dataset.

    In a broadcast join, the left side of the join (broadcastTree) is broadcast to to all the nodes in the cluster. The key equality function used for this join is the reference region overlap function. Since this is a right outer join, all values in the left genomic dataset that do not overlap a value from the right genomic dataset are dropped. If a value from the right genomic dataset does not overlap any values in the left genomic dataset, it will be paired with a None in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the right genomic dataset that did not overlap a key in the left genomic dataset.

    Definition Classes
    GenomicDataset
    See also

    rightOuterBroadcastRegionJoinAgainstAndGroupByRight

  89. def rightOuterBroadcastRegionJoinAndGroupByRight[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Integer): GenericGenomicDataset[(Iterable[NucleotideContigFragment], X), (Seq[NucleotideContigFragment], Y)]

    Permalink

    (Java-specific) Performs a broadcast right outer join between this genomic dataset and another genomic dataset.

    (Java-specific) Performs a broadcast right outer join between this genomic dataset and another genomic dataset.

    In a broadcast join, the left side of the join (broadcastTree) is broadcast to to all the nodes in the cluster. The key equality function used for this join is the reference region overlap function. Since this is a right outer join, all values in the left genomic dataset that do not overlap a value from the right genomic dataset are dropped. If a value from the right genomic dataset does not overlap any values in the left genomic dataset, it will be paired with a None in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the right genomic dataset that did not overlap a key in the left genomic dataset.

    Definition Classes
    GenomicDataset
    See also

    rightOuterBroadcastRegionJoinAgainstAndGroupByRight

  90. def rightOuterBroadcastRegionJoinAndGroupByRight[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Double): GenericGenomicDataset[(Iterable[NucleotideContigFragment], X), (Seq[NucleotideContigFragment], Y)]

    Permalink

    (R-specific) Performs a broadcast right outer join between this genomic dataset and another genomic dataset.

    (R-specific) Performs a broadcast right outer join between this genomic dataset and another genomic dataset.

    In a broadcast join, the left side of the join (broadcastTree) is broadcast to to all the nodes in the cluster. The key equality function used for this join is the reference region overlap function. Since this is a right outer join, all values in the left genomic dataset that do not overlap a value from the right genomic dataset are dropped. If a value from the right genomic dataset does not overlap any values in the left genomic dataset, it will be paired with a None in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the right genomic dataset that did not overlap a key in the left genomic dataset.

    Definition Classes
    GenomicDataset
    See also

    rightOuterBroadcastRegionJoinAgainstAndGroupByRight

  91. def rightOuterShuffleRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z])(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], otxTag: ClassTag[(Option[NucleotideContigFragment], X)], ouyTag: scala.reflect.api.JavaUniverse.TypeTag[(Option[NucleotideContigFragment], Y)]): GenericGenomicDataset[(Option[NucleotideContigFragment], X), (Option[NucleotideContigFragment], Y)]

    Permalink

    Performs a sort-merge right outer join between this genomic dataset and another genomic dataset.

    Performs a sort-merge right outer join between this genomic dataset and another genomic dataset.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is a right outer join, all values in the left genomic dataset that do not overlap a value from the right genomic dataset are dropped. If a value from the right genomic dataset does not overlap any values in the left genomic dataset, it will be paired with a None in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the right genomic dataset that did not overlap a key in the left genomic dataset.

    Definition Classes
    GenomicDataset
  92. def rightOuterShuffleRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Long)(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], otxTag: ClassTag[(Option[NucleotideContigFragment], X)], ouyTag: scala.reflect.api.JavaUniverse.TypeTag[(Option[NucleotideContigFragment], Y)]): GenericGenomicDataset[(Option[NucleotideContigFragment], X), (Option[NucleotideContigFragment], Y)]

    Permalink

    Performs a sort-merge right outer join between this genomic dataset and another genomic dataset.

    Performs a sort-merge right outer join between this genomic dataset and another genomic dataset.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is a right outer join, all values in the left genomic dataset that do not overlap a value from the right genomic dataset are dropped. If a value from the right genomic dataset does not overlap any values in the left genomic dataset, it will be paired with a None in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the right genomic dataset that did not overlap a key in the left genomic dataset.

    Definition Classes
    GenomicDataset
  93. def rightOuterShuffleRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Integer): GenericGenomicDataset[(Option[NucleotideContigFragment], X), (Option[NucleotideContigFragment], Y)]

    Permalink

    (Java-specific) Performs a sort-merge right outer join between this genomic dataset and another genomic dataset.

    (Java-specific) Performs a sort-merge right outer join between this genomic dataset and another genomic dataset.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is a right outer join, all values in the left genomic dataset that do not overlap a value from the right genomic dataset are dropped. If a value from the right genomic dataset does not overlap any values in the left genomic dataset, it will be paired with a None in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the right genomic dataset that did not overlap a key in the left genomic dataset.

    Definition Classes
    GenomicDataset
  94. def rightOuterShuffleRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Double): GenericGenomicDataset[(Option[NucleotideContigFragment], X), (Option[NucleotideContigFragment], Y)]

    Permalink

    (R-specific) Performs a sort-merge right outer join between this genomic dataset and another genomic dataset.

    (R-specific) Performs a sort-merge right outer join between this genomic dataset and another genomic dataset.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is a right outer join, all values in the left genomic dataset that do not overlap a value from the right genomic dataset are dropped. If a value from the right genomic dataset does not overlap any values in the left genomic dataset, it will be paired with a None in the product of the join.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the right genomic dataset that did not overlap a key in the left genomic dataset.

    Definition Classes
    GenomicDataset
  95. def rightOuterShuffleRegionJoinAndGroupByLeft[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z])(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], otixTag: ClassTag[(Option[NucleotideContigFragment], Iterable[X])], otsyTag: scala.reflect.api.JavaUniverse.TypeTag[(Option[NucleotideContigFragment], Seq[Y])]): GenericGenomicDataset[(Option[NucleotideContigFragment], Iterable[X]), (Option[NucleotideContigFragment], Seq[Y])]

    Permalink

    Performs a sort-merge right outer join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value, if not null.

    Performs a sort-merge right outer join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value, if not null.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. In the same operation, we group all values by the left item in the genomic dataset. Since this is a right outer join, all values from the right genomic dataset who did not overlap a value from the left genomic dataset are placed into a length-1 Iterable with a None key.

    genomicDataset

    The right genomic dataset in the join.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, grouped together by the value they overlapped in the left genomic dataset, and all values from the right genomic dataset that did not overlap an item in the left genomic dataset.

    Definition Classes
    GenomicDataset
  96. def rightOuterShuffleRegionJoinAndGroupByLeft[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Long)(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], otixTag: ClassTag[(Option[NucleotideContigFragment], Iterable[X])], ousyTag: scala.reflect.api.JavaUniverse.TypeTag[(Option[NucleotideContigFragment], Seq[Y])]): GenericGenomicDataset[(Option[NucleotideContigFragment], Iterable[X]), (Option[NucleotideContigFragment], Seq[Y])]

    Permalink

    Performs a sort-merge right outer join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value, if not null.

    Performs a sort-merge right outer join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value, if not null.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. In the same operation, we group all values by the left item in the genomic dataset. Since this is a right outer join, all values from the right genomic dataset who did not overlap a value from the left genomic dataset are placed into a length-1 Iterable with a None key.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, grouped together by the value they overlapped in the left genomic dataset, and all values from the right genomic dataset that did not overlap an item in the left genomic dataset.

    Definition Classes
    GenomicDataset
  97. def rightOuterShuffleRegionJoinAndGroupByLeft[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Integer): GenericGenomicDataset[(Option[NucleotideContigFragment], Iterable[X]), (Option[NucleotideContigFragment], Seq[Y])]

    Permalink

    (Java-specific) Performs a sort-merge right outer join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value, if not null.

    (Java-specific) Performs a sort-merge right outer join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value, if not null.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. In the same operation, we group all values by the left item in the genomic dataset. Since this is a right outer join, all values from the right genomic dataset who did not overlap a value from the left genomic dataset are placed into a length-1 Iterable with a None key.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, grouped together by the value they overlapped in the left genomic dataset, and all values from the right genomic dataset that did not overlap an item in the left genomic dataset.

    Definition Classes
    GenomicDataset
  98. def rightOuterShuffleRegionJoinAndGroupByLeft[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Double): GenericGenomicDataset[(Option[NucleotideContigFragment], Iterable[X]), (Option[NucleotideContigFragment], Seq[Y])]

    Permalink

    (R-specific) Performs a sort-merge right outer join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value, if not null.

    (R-specific) Performs a sort-merge right outer join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value, if not null.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. In the same operation, we group all values by the left item in the genomic dataset. Since this is a right outer join, all values from the right genomic dataset who did not overlap a value from the left genomic dataset are placed into a length-1 Iterable with a None key.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, grouped together by the value they overlapped in the left genomic dataset, and all values from the right genomic dataset that did not overlap an item in the left genomic dataset.

    Definition Classes
    GenomicDataset
  99. def save(fileName: String, asSingleFile: Boolean): Unit

    Permalink

    Save nucleotide contig fragments as Parquet or FASTA.

    Save nucleotide contig fragments as Parquet or FASTA.

    If filename ends in .fa or .fasta, saves as Fasta. If not, saves fragments to Parquet. Defaults to 60 character line length, if saving to FASTA.

    fileName

    file name

    asSingleFile

    If false, writes file to disk as shards with one shard per partition. If true, we save the file to disk as a single file by merging the shards.

    Definition Classes
    NucleotideContigFragmentDataset
  100. def saveAsFasta(fileName: String, lineWidth: Int = 60, asSingleFile: Boolean = false, disableFastConcat: Boolean = false): Unit

    Permalink

    Save nucleotide contig fragments in FASTA format.

    Save nucleotide contig fragments in FASTA format.

    fileName

    file name

    lineWidth

    hard wrap FASTA formatted sequence at line width, default 60

    asSingleFile

    By default (false), writes file to disk as shards with one shard per partition. If true, we save the file to disk as a single file by merging the shards.

    disableFastConcat

    If asSingleFile is true, disables the use of the parallel file merging engine.

    Definition Classes
    NucleotideContigFragmentDataset
  101. def saveAsParquet(pathName: String): Unit

    Permalink

    Saves this genomic dataset to disk as a Parquet file.

    Saves this genomic dataset to disk as a Parquet file.

    pathName

    Path to save the file at.

    Definition Classes
    AvroGenomicDataset
  102. def saveAsParquet(pathName: String, blockSize: Integer, pageSize: Integer, compressCodec: CompressionCodecName, disableDictionaryEncoding: Boolean): Unit

    Permalink

    (Java-specific) Saves this genomic dataset to disk as a Parquet file.

    (Java-specific) Saves this genomic dataset to disk as a Parquet file.

    pathName

    Path to save the file at.

    blockSize

    The size in bytes of blocks to write.

    pageSize

    The size in bytes of pages to write.

    compressCodec

    The compression codec to apply to pages.

    disableDictionaryEncoding

    If false, dictionary encoding is used. If true, delta encoding is used.

    Definition Classes
    AvroGenomicDataset
  103. def saveAsParquet(pathName: String, blockSize: Int = 128 * 1024 * 1024, pageSize: Int = 1 * 1024 * 1024, compressCodec: CompressionCodecName = CompressionCodecName.GZIP, disableDictionaryEncoding: Boolean = false): Unit

    Permalink

    Saves this genomic dataset to disk as a Parquet file.

    Saves this genomic dataset to disk as a Parquet file.

    pathName

    Path to save the file at.

    blockSize

    Size per block.

    pageSize

    Size per page.

    compressCodec

    Name of the compression codec to use.

    disableDictionaryEncoding

    Whether or not to disable bit-packing. Default is false.

    Definition Classes
    AvroGenomicDatasetGenomicDataset
  104. def saveAsParquet(args: SaveArgs): Unit

    Permalink

    Saves a genomic dataset to Parquet.

    Saves a genomic dataset to Parquet.

    args

    The output format configuration to use when saving the data.

    Definition Classes
    GenomicDataset
  105. def saveAsPartitionedParquet(pathName: String, compressCodec: CompressionCodecName = CompressionCodecName.GZIP, partitionSize: Int = 1000000): Unit

    Permalink

    Saves this RDD to disk in range binned partitioned Parquet format.

    Saves this RDD to disk in range binned partitioned Parquet format.

    pathName

    The path to save the partitioned Parquet file to.

    compressCodec

    Name of the compression codec to use.

    partitionSize

    Size of partitions used when writing Parquet, in base pairs (bp). Defaults to 1,000,000 bp.

    Definition Classes
    NucleotideContigFragmentDatasetGenomicDataset
  106. def saveAvro[U <: SpecificRecordBase](pathName: String, sc: SparkContext, schema: Schema, avro: Seq[U])(implicit tUag: ClassTag[U]): Unit

    Permalink

    Saves Avro data to a Hadoop file system.

    Saves Avro data to a Hadoop file system.

    This method uses a SparkContext to identify our underlying file system, which we then save to.

    Frustratingly enough, although all records generated by the Avro IDL compiler have a static SCHEMA$ field, this field does not belong to the SpecificRecordBase abstract class, or the SpecificRecord interface. As such, we must force the user to pass in the schema.

    U

    The type of the specific record we are saving.

    pathName

    Path to save records to.

    sc

    SparkContext used for identifying underlying file system.

    schema

    Schema of records we are saving.

    avro

    Seq of records we are saving.

    Attributes
    protected
    Definition Classes
    GenomicDataset
  107. def saveMetadata(pathName: String): Unit

    Permalink

    Called in saveAsParquet after saving genomic dataset to Parquet to save metadata.

    Called in saveAsParquet after saving genomic dataset to Parquet to save metadata.

    Writes any necessary metadata to disk. If not overridden, writes the sequence dictionary to disk as Avro.

    pathName

    The filepath to the file where we will save the Metadata.

    Attributes
    protected
    Definition Classes
    AvroGenomicDatasetGenomicDataset
  108. def savePartitionMap(pathName: String): Unit

    Permalink

    Save the partition map to disk.

    Save the partition map to disk. This is done by adding the partition map to the schema.

    pathName

    The filepath where we will save the partition map.

    Attributes
    protected
    Definition Classes
    AvroGenomicDataset
  109. def saveRddAsParquet(pathName: String, blockSize: Int = 128 * 1024 * 1024, pageSize: Int = 1 * 1024 * 1024, compressCodec: CompressionCodecName = CompressionCodecName.GZIP, disableDictionaryEncoding: Boolean = false, optSchema: Option[Schema] = None): Unit

    Permalink

    Saves a genomic dataset of Avro data to Parquet.

    Saves a genomic dataset of Avro data to Parquet.

    pathName

    The path to save the file to.

    blockSize

    The size in bytes of blocks to write. Defaults to 128 * 1024 * 1024.

    pageSize

    The size in bytes of pages to write. Defaults to 1 * 1024 * 1024.

    compressCodec

    The compression codec to apply to pages. Defaults to CompressionCodecName.GZIP.

    disableDictionaryEncoding

    If false, dictionary encoding is used. If true, delta encoding is used. Defaults to false.

    optSchema

    The optional schema to set. Defaults to None.

    Attributes
    protected
    Definition Classes
    AvroGenomicDataset
  110. def saveRddAsParquet(args: SaveArgs): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    AvroGenomicDataset
  111. def saveSequences(pathName: String): Unit

    Permalink

    Save the sequence dictionary to disk.

    Save the sequence dictionary to disk.

    pathName

    The path to save the sequence dictionary to.

    Attributes
    protected
    Definition Classes
    GenomicDataset
  112. val sequences: SequenceDictionary

    Permalink

    Sequence dictionary computed from rdd

    Sequence dictionary computed from rdd

    Definition Classes
    RDDBoundNucleotideContigFragmentDatasetGenomicDataset
  113. def shuffleRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z])(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], txTag: ClassTag[(NucleotideContigFragment, X)], uyTag: scala.reflect.api.JavaUniverse.TypeTag[(NucleotideContigFragment, Y)]): GenericGenomicDataset[(NucleotideContigFragment, X), (NucleotideContigFragment, Y)]

    Permalink

    Performs a sort-merge inner join between this genomic dataset and another genomic dataset.

    Performs a sort-merge inner join between this genomic dataset and another genomic dataset.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is an inner join, all values who do not overlap a value from the other genomic dataset are dropped.

    genomicDataset

    The right genomic dataset in the join.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.

    Definition Classes
    GenomicDataset
  114. def shuffleRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Long)(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], txTag: ClassTag[(NucleotideContigFragment, X)], uyTag: scala.reflect.api.JavaUniverse.TypeTag[(NucleotideContigFragment, Y)]): GenericGenomicDataset[(NucleotideContigFragment, X), (NucleotideContigFragment, Y)]

    Permalink

    Performs a sort-merge inner join between this genomic dataset and another genomic dataset.

    Performs a sort-merge inner join between this genomic dataset and another genomic dataset.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is an inner join, all values who do not overlap a value from the other genomic dataset are dropped.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.

    Definition Classes
    GenomicDataset
  115. def shuffleRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Integer): GenericGenomicDataset[(NucleotideContigFragment, X), (NucleotideContigFragment, Y)]

    Permalink

    (Java-specific) Performs a sort-merge inner join between this genomic dataset and another genomic dataset.

    (Java-specific) Performs a sort-merge inner join between this genomic dataset and another genomic dataset.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is an inner join, all values who do not overlap a value from the other genomic dataset are dropped.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.

    Definition Classes
    GenomicDataset
  116. def shuffleRegionJoin[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Double): GenericGenomicDataset[(NucleotideContigFragment, X), (NucleotideContigFragment, Y)]

    Permalink

    (R-specific) Performs a sort-merge inner join between this genomic dataset and another genomic dataset.

    (R-specific) Performs a sort-merge inner join between this genomic dataset and another genomic dataset.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is an inner join, all values who do not overlap a value from the other genomic dataset are dropped.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.

    Definition Classes
    GenomicDataset
  117. def shuffleRegionJoinAndGroupByLeft[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z])(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], tixTag: ClassTag[(NucleotideContigFragment, Iterable[X])], uiyTag: scala.reflect.api.JavaUniverse.TypeTag[(NucleotideContigFragment, Seq[Y])]): GenericGenomicDataset[(NucleotideContigFragment, Iterable[X]), (NucleotideContigFragment, Seq[Y])]

    Permalink

    Performs a sort-merge inner join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value.

    Performs a sort-merge inner join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is an inner join, all values who do not overlap a value from the other genomic dataset are dropped. In the same operation, we group all values by the left item in the genomic dataset.

    genomicDataset

    The right genomic dataset in the join.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, grouped together by the value they overlapped in the left genomic dataset.

    Definition Classes
    GenomicDataset
  118. def shuffleRegionJoinAndGroupByLeft[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Long)(implicit tTag: ClassTag[NucleotideContigFragment], xTag: ClassTag[X], tixTag: ClassTag[(NucleotideContigFragment, Iterable[X])], uiyTag: scala.reflect.api.JavaUniverse.TypeTag[(NucleotideContigFragment, Seq[Y])]): GenericGenomicDataset[(NucleotideContigFragment, Iterable[X]), (NucleotideContigFragment, Seq[Y])]

    Permalink

    Performs a sort-merge inner join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value.

    Performs a sort-merge inner join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. Since this is an inner join, all values who do not overlap a value from the other genomic dataset are dropped. In the same operation, we group all values by the left item in the genomic dataset.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, grouped together by the value they overlapped in the left genomic dataset.

    Definition Classes
    GenomicDataset
  119. def shuffleRegionJoinAndGroupByLeft[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Integer): GenericGenomicDataset[(NucleotideContigFragment, Iterable[X]), (NucleotideContigFragment, Seq[Y])]

    Permalink

    (Java-specific) Performs a sort-merge inner join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value.

    (Java-specific) Performs a sort-merge inner join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. In the same operation, we group all values by the left item in the genomic dataset.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, grouped together by the value they overlapped in the left genomic dataset.

    Definition Classes
    GenomicDataset
  120. def shuffleRegionJoinAndGroupByLeft[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](genomicDataset: GenomicDataset[X, Y, Z], flankSize: Double): GenericGenomicDataset[(NucleotideContigFragment, Iterable[X]), (NucleotideContigFragment, Seq[Y])]

    Permalink

    (R-specific) Performs a sort-merge inner join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value.

    (R-specific) Performs a sort-merge inner join between this genomic dataset and another genomic dataset, followed by a groupBy on the left value.

    In a sort-merge join, both genomic datasets are co-partitioned and sorted. The partitions are then zipped, and we do a merge join on each partition. The key equality function used for this join is the reference region overlap function. In the same operation, we group all values by the left item in the genomic dataset.

    genomicDataset

    The right genomic dataset in the join.

    flankSize

    Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.

    returns

    Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space, grouped together by the value they overlapped in the left genomic dataset.

    Definition Classes
    GenomicDataset
  121. def sort(partitions: Int = rdd.partitions.length, stringency: ValidationStringency = ValidationStringency.STRICT)(implicit tTag: ClassTag[NucleotideContigFragment]): NucleotideContigFragmentDataset

    Permalink

    Sorts our genome aligned data by reference positions, with references ordered by index.

    Sorts our genome aligned data by reference positions, with references ordered by index.

    partitions

    The number of partitions for the new genomic dataset.

    stringency

    The level of ValidationStringency to enforce.

    returns

    Returns a new genomic dataset containing sorted data.

    Definition Classes
    GenomicDataset
    Note

    Uses ValidationStringency to handle unaligned or where objects align to multiple positions.

    See also

    sortLexicographically

  122. def sort(): NucleotideContigFragmentDataset

    Permalink

    Sorts our genome aligned data by reference positions, with references ordered by index.

    Sorts our genome aligned data by reference positions, with references ordered by index.

    returns

    Returns a new genomic dataset containing sorted data.

    Definition Classes
    GenomicDataset
    See also

    sortLexicographically

  123. def sortLexicographically(partitions: Int = rdd.partitions.length, storePartitionMap: Boolean = false, storageLevel: StorageLevel = StorageLevel.MEMORY_ONLY, stringency: ValidationStringency = ValidationStringency.STRICT)(implicit tTag: ClassTag[NucleotideContigFragment]): NucleotideContigFragmentDataset

    Permalink

    Sorts our genome aligned data by reference positions, with references ordered lexicographically.

    Sorts our genome aligned data by reference positions, with references ordered lexicographically.

    partitions

    The number of partitions for the new genomic dataset.

    storePartitionMap

    A Boolean flag to determine whether to store the partition bounds from the resulting genomic dataset.

    storageLevel

    The level at which to persist the resulting genomic dataset.

    stringency

    The level of ValidationStringency to enforce.

    returns

    Returns a new genomic dataset containing sorted data.

    Definition Classes
    GenomicDataset
    Note

    Uses ValidationStringency to handle data that is unaligned or where objects align to multiple positions.

    See also

    sort

  124. def sortLexicographically(): NucleotideContigFragmentDataset

    Permalink

    Sorts our genome aligned data by reference positions, with references ordered lexicographically.

    Sorts our genome aligned data by reference positions, with references ordered lexicographically.

    returns

    Returns a new genomic dataset containing sorted data.

    Definition Classes
    GenomicDataset
    See also

    sort

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

    Permalink
    Definition Classes
    AnyRef
  126. def toDF(): DataFrame

    Permalink

    returns

    These data as a Spark SQL DataFrame.

    Definition Classes
    GenomicDataset
  127. def toReads: RDD[AlignmentRecord]

    Permalink

    Converts an RDD of nucleotide contig fragments into reads.

    Converts an RDD of nucleotide contig fragments into reads. Adjacent contig fragments are combined.

    returns

    Returns an RDD of reads.

    Definition Classes
    NucleotideContigFragmentDataset
  128. def toString(): String

    Permalink
    Definition Classes
    GenomicDataset → AnyRef → Any
  129. def trace(mkr: Marker, msg: ⇒ Any, t: ⇒ Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  130. def trace(msg: ⇒ Any, t: ⇒ Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  131. def trace(msg: ⇒ Any): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  132. def transform(tFn: Function[JavaRDD[NucleotideContigFragment], JavaRDD[NucleotideContigFragment]]): NucleotideContigFragmentDataset

    Permalink

    (Java-specific) Applies a function that transforms the underlying RDD into a new RDD.

    (Java-specific) Applies a function that transforms the underlying RDD into a new RDD.

    tFn

    A function that transforms the underlying RDD.

    returns

    A new genomic dataset where the RDD of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.

    Definition Classes
    GenomicDataset
  133. def transform(tFn: (RDD[NucleotideContigFragment]) ⇒ RDD[NucleotideContigFragment]): NucleotideContigFragmentDataset

    Permalink

    (Scala-specific) Applies a function that transforms the underlying RDD into a new RDD.

    (Scala-specific) Applies a function that transforms the underlying RDD into a new RDD.

    tFn

    A function that transforms the underlying RDD.

    returns

    A new genomic dataset where the RDD of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.

    Definition Classes
    GenomicDataset
  134. def transformDataFrame(tFn: Function[DataFrame, DataFrame]): NucleotideContigFragmentDataset

    Permalink

    (Java-specific) Applies a function that transforms the underlying DataFrame into a new DataFrame using the Spark SQL API.

    (Java-specific) Applies a function that transforms the underlying DataFrame into a new DataFrame using the Spark SQL API.

    tFn

    A function that transforms the underlying DataFrame as a DataFrame.

    returns

    A new genomic dataset where the DataFrame of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.

    Definition Classes
    GenomicDataset
  135. def transformDataFrame(tFn: (DataFrame) ⇒ DataFrame)(implicit uTag: scala.reflect.api.JavaUniverse.TypeTag[NucleotideContigFragment]): NucleotideContigFragmentDataset

    Permalink

    (Scala-specific) Applies a function that transforms the underlying DataFrame into a new DataFrame using the Spark SQL API.

    (Scala-specific) Applies a function that transforms the underlying DataFrame into a new DataFrame using the Spark SQL API.

    tFn

    A function that transforms the underlying data as a DataFrame.

    returns

    A new genomic dataset where the DataFrame of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.

    Definition Classes
    GenomicDataset
  136. def transformDataset(tFn: Function[Dataset[NucleotideContigFragment], Dataset[NucleotideContigFragment]]): NucleotideContigFragmentDataset

    Permalink

    (Java-specific) Applies a function that transforms the underlying Dataset into a new Dataset using the Spark SQL API.

    (Java-specific) Applies a function that transforms the underlying Dataset into a new Dataset using the Spark SQL API.

    tFn

    A function that transforms the underlying Dataset as a Dataset.

    returns

    A new genomic dataset where the Dataset of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.

    Definition Classes
    NucleotideContigFragmentDatasetGenomicDataset
  137. def transformDataset(tFn: (Dataset[NucleotideContigFragment]) ⇒ Dataset[NucleotideContigFragment]): NucleotideContigFragmentDataset

    Permalink

    (Scala-specific) Applies a function that transforms the underlying Dataset into a new Dataset using the Spark SQL API.

    (Scala-specific) Applies a function that transforms the underlying Dataset into a new Dataset using the Spark SQL API.

    tFn

    A function that transforms the underlying Dataset as a Dataset.

    returns

    A new genomic dataset where the Dataset of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.

    Definition Classes
    NucleotideContigFragmentDatasetGenomicDataset
  138. def transmute[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](tFn: Function[JavaRDD[NucleotideContigFragment], JavaRDD[X]], convFn: Function2[NucleotideContigFragmentDataset, RDD[X], Z]): Z

    Permalink

    (Java-specific) Applies a function that transmutes the underlying RDD into a new RDD of a different type.

    (Java-specific) Applies a function that transmutes the underlying RDD into a new RDD of a different type.

    tFn

    A function that transforms the underlying RDD.

    convFn

    The conversion function used to build the final RDD.

    returns

    A new genomid dataset where the RDD of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.

    Definition Classes
    GenomicDataset
  139. def transmute[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](tFn: (RDD[NucleotideContigFragment]) ⇒ RDD[X])(implicit convFn: (NucleotideContigFragmentDataset, RDD[X]) ⇒ Z): Z

    Permalink

    (Scala-specific) Applies a function that transmutes the underlying RDD into a new RDD of a different type.

    (Scala-specific) Applies a function that transmutes the underlying RDD into a new RDD of a different type.

    tFn

    A function that transforms the underlying RDD.

    returns

    A new genomic dataset where the RDD of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.

    Definition Classes
    GenomicDataset
  140. def transmuteDataFrame[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](tFn: Function[DataFrame, DataFrame], convFn: GenomicDatasetConversion[NucleotideContigFragment, NucleotideContigFragment, NucleotideContigFragmentDataset, X, Y, Z]): Z

    Permalink

    (Java-specific) Applies a function that transmutes the underlying DataFrame into a new DataFrame of a different type.

    (Java-specific) Applies a function that transmutes the underlying DataFrame into a new DataFrame of a different type.

    tFn

    A function that transforms the underlying DataFrame.

    returns

    A new genomic dataset where the DataFrame of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.

    Definition Classes
    GenomicDataset
  141. def transmuteDataFrame[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](tFn: (DataFrame) ⇒ DataFrame)(implicit yTag: scala.reflect.api.JavaUniverse.TypeTag[Y], convFn: (NucleotideContigFragmentDataset, Dataset[Y]) ⇒ Z): Z

    Permalink

    (Java-specific) Applies a function that transmutes the underlying DataFrame into a new DataFrame of a different type.

    (Java-specific) Applies a function that transmutes the underlying DataFrame into a new DataFrame of a different type.

    tFn

    A function that transforms the underlying DataFrame.

    returns

    A new genomic dataset where the DataFrame of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.

    Definition Classes
    GenomicDataset
  142. def transmuteDataset[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](tFn: Function[Dataset[NucleotideContigFragment], Dataset[Y]], convFn: GenomicDatasetConversion[NucleotideContigFragment, NucleotideContigFragment, NucleotideContigFragmentDataset, X, Y, Z]): Z

    Permalink

    (Java-specific) Applies a function that transmutes the underlying Dataset into a new Dataset of a different type.

    (Java-specific) Applies a function that transmutes the underlying Dataset into a new Dataset of a different type.

    tFn

    A function that transforms the underlying Dataset.

    returns

    A new genomic dataset where the Dataset of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.

    Definition Classes
    GenomicDataset
  143. def transmuteDataset[X, Y <: Product, Z <: GenomicDataset[X, Y, Z]](tFn: (Dataset[NucleotideContigFragment]) ⇒ Dataset[Y])(implicit yTag: scala.reflect.api.JavaUniverse.TypeTag[Y], convFn: (NucleotideContigFragmentDataset, Dataset[Y]) ⇒ Z): Z

    Permalink

    (Scala-specific) Applies a function that transmutes the underlying Dataset into a new Dataset of a different type.

    (Scala-specific) Applies a function that transmutes the underlying Dataset into a new Dataset of a different type.

    tFn

    A function that transforms the underlying Dataset.

    returns

    A new genomic dataset where the Dataset of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.

    Definition Classes
    GenomicDataset
  144. val uTag: scala.reflect.api.JavaUniverse.TypeTag[NucleotideContigFragment]

    Permalink
  145. def union(datasets: NucleotideContigFragmentDataset*): NucleotideContigFragmentDataset

    Permalink

    (Scala-specific) Unions together multiple genomic datasets.

    (Scala-specific) Unions together multiple genomic datasets.

    datasets

    Genomic datasets to union with this genomic dataset.

    Definition Classes
    NucleotideContigFragmentDatasetGenomicDataset
  146. def union(datasets: List[NucleotideContigFragmentDataset]): NucleotideContigFragmentDataset

    Permalink

    (Java-specific) Unions together multiple genomic datasets.

    (Java-specific) Unions together multiple genomic datasets.

    datasets

    Genomic datasets to union with this genomic dataset.

    Definition Classes
    GenomicDataset
  147. def unpersist(): NucleotideContigFragmentDataset

    Permalink

    Unpersists underlying RDD from memory or disk.

    Unpersists underlying RDD from memory or disk.

    returns

    Uncached GenomicDataset.

    Definition Classes
    GenomicDataset
  148. val unproductFn: (NucleotideContigFragment) ⇒ NucleotideContigFragment

    Permalink
    Attributes
    protected
    Definition Classes
    NucleotideContigFragmentDatasetGenomicDataset
  149. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  152. def warn(mkr: Marker, msg: ⇒ Any, t: ⇒ Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  153. def warn(msg: ⇒ Any, t: ⇒ Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  154. def warn(msg: ⇒ Any): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  155. def writePartitionedParquetFlag(pathName: String, partitionSize: Int): Unit

    Permalink

    Save partition size into the partitioned Parquet flag file.

    Save partition size into the partitioned Parquet flag file.

    pathName

    Path to save the file at.

    partitionSize

    Partition bin size, in base pairs, used in Hive-style partitioning.

    Definition Classes
    AvroGenomicDatasetGenomicDataset
  156. def writeTextRdd[T](rdd: RDD[T], outputPath: String, asSingleFile: Boolean, disableFastConcat: Boolean, optHeaderPath: Option[String] = None): Unit

    Permalink

    Writes an RDD to disk as text and optionally merges.

    Writes an RDD to disk as text and optionally merges.

    rdd

    RDD to save.

    outputPath

    Output path to save text files to.

    asSingleFile

    If true, combines all partition shards.

    disableFastConcat

    If asSingleFile is true, disables the use of the parallel file merging engine.

    optHeaderPath

    If provided, the header file to include.

    Attributes
    protected
    Definition Classes
    GenomicDataset

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from GenomicDataset[NucleotideContigFragment, NucleotideContigFragment, NucleotideContigFragmentDataset]

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped