Class

org.bdgenomics.adam.rdd.feature

RDDBoundFeatureRDD

Related Doc: package feature

Permalink

case class RDDBoundFeatureRDD extends FeatureRDD with Product with Serializable

Linear Supertypes
Product, Equals, FeatureRDD, AvroGenomicRDD[Feature, Feature, FeatureRDD], GenomicDataset[Feature, Feature, FeatureRDD], GenomicRDD[Feature, FeatureRDD], ADAMRDDFunctions[Feature], Logging, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RDDBoundFeatureRDD
  2. Product
  3. Equals
  4. FeatureRDD
  5. AvroGenomicRDD
  6. GenomicDataset
  7. GenomicRDD
  8. ADAMRDDFunctions
  9. Logging
  10. Serializable
  11. Serializable
  12. AnyRef
  13. 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): FeatureRDD

    Permalink

    Appends metadata for a single sequence to the current RDD.

    Appends metadata for a single sequence to the current RDD.

    sequenceToAdd

    The sequence to add.

    returns

    Returns a new GenomicRDD with this sequence appended.

    Definition Classes
    GenomicRDD
  5. def addSequences(sequencesToAdd: SequenceDictionary): FeatureRDD

    Permalink

    Appends sequence metadata to the current RDD.

    Appends sequence metadata to the current RDD.

    sequencesToAdd

    The new sequences to append.

    returns

    Returns a new GenomicRDD with the sequences appended.

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

    Permalink
    Definition Classes
    Any
  7. def broadcast()(implicit tTag: ClassTag[Feature]): Broadcast[IntervalArray[ReferenceRegion, Feature]]

    Permalink
    Definition Classes
    GenomicRDD
  8. def broadcastRegionJoin[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y])(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], txTag: ClassTag[(Feature, X)]): GenericGenomicRDD[(Feature, X)]

    Permalink

    Performs a broadcast inner join between this RDD and another RDD.

    Performs a broadcast inner join between this RDD and another RDD.

    In a broadcast join, the left RDD (this RDD) 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 RDD are dropped.

    genomicRdd

    The right RDD in the join.

    returns

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

    Definition Classes
    GenomicRDD
    See also

    broadcastRegionJoinAgainst

  9. def broadcastRegionJoin[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y], flankSize: Long)(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], txTag: ClassTag[(Feature, X)]): GenericGenomicRDD[(Feature, X)]

    Permalink

    Performs a broadcast inner join between this RDD and another RDD.

    Performs a broadcast inner join between this RDD and another RDD.

    In a broadcast join, the left RDD (this RDD) 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 RDD are dropped.

    genomicRdd

    The right RDD 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 RDD containing all pairs of keys that overlapped in the genomic coordinate space.

    Definition Classes
    GenomicRDD
    See also

    broadcastRegionJoinAgainst

  10. def broadcastRegionJoinAgainst[X](broadcastTree: Broadcast[IntervalArray[ReferenceRegion, X]])(implicit tTag: ClassTag[Feature], xTag: ClassTag[X]): GenericGenomicRDD[(X, Feature)]

    Permalink

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

    Performs a broadcast inner join between this RDD 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 RDD are dropped. As compared to broadcastRegionJoin, this function allows the broadcast object to be reused across multiple joins.

    broadcastTree

    The data on the left side of the join.

    returns

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

    Definition Classes
    GenomicRDD
    Note

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

    See also

    broadcastRegionJoin

  11. def broadcastRegionJoinAgainstAndGroupByRight[X, Y <: GenomicRDD[X, Y]](broadcastTree: Broadcast[IntervalArray[ReferenceRegion, X]])(implicit tTag: ClassTag[Feature], xTag: ClassTag[X]): GenericGenomicRDD[(Iterable[X], Feature)]

    Permalink

    Performs a broadcast inner join between this RDD and another RDD.

    Performs a broadcast inner join between this RDD and another RDD.

    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 RDD are dropped. As compared to broadcastRegionJoin, this function allows the broadcast object to be reused across multiple joins.

    broadcastTree

    The data on the left side of the join.

    returns

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

    Definition Classes
    GenomicRDD
    Note

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

    See also

    broadcastRegionJoinAndGroupByRight

  12. def broadcastRegionJoinAndGroupByRight[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y])(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], itxTag: ClassTag[(Iterable[Feature], X)]): GenericGenomicRDD[(Iterable[Feature], X)]

    Permalink

    Performs a broadcast inner join between this RDD and another RDD.

    Performs a broadcast inner join between this RDD and another RDD.

    In a broadcast join, the left RDD (this RDD) 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 RDD are dropped.

    genomicRdd

    The right RDD in the join.

    returns

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

    Definition Classes
    GenomicRDD
    See also

    broadcastRegionJoinAgainstAndGroupByRight

  13. def broadcastRegionJoinAndGroupByRight[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y], flankSize: Long)(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], itxTag: ClassTag[(Iterable[Feature], X)]): GenericGenomicRDD[(Iterable[Feature], X)]

    Permalink

    Performs a broadcast inner join between this RDD and another RDD.

    Performs a broadcast inner join between this RDD and another RDD.

    In a broadcast join, the left RDD (this RDD) 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 RDD are dropped.

    genomicRdd

    The right RDD 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 RDD containing all pairs of keys that overlapped in the genomic coordinate space.

    Definition Classes
    GenomicRDD
    See also

    broadcastRegionJoinAgainstAndGroupByRight

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

    Permalink
    Attributes
    protected
    Definition Classes
    FeatureRDDGenomicRDD
  15. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. lazy val dataset: Dataset[Feature]

    Permalink

    A SQL Dataset of reads.

    A SQL Dataset of reads.

    Definition Classes
    RDDBoundFeatureRDDGenomicDataset
  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def filterByOverlappingRegion(query: ReferenceRegion): FeatureRDD

    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 GenomicRDD containing only data that overlaps the query region.

    Definition Classes
    GenomicRDD
  19. def filterByOverlappingRegions(querys: Iterable[ReferenceRegion]): FeatureRDD

    Permalink

    Runs a filter that selects data in the underlying RDD that overlaps several genomic regions.

    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 GenomicRDD containing only data that overlaps the querys region.

    Definition Classes
    GenomicRDD
  20. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. def flattenRddByRegions(): RDD[(ReferenceRegion, Feature)]

    Permalink
    Attributes
    protected
    Definition Classes
    GenomicRDD
  22. def fullOuterShuffleRegionJoin[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y])(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], otoxTag: ClassTag[(Option[Feature], Option[X])]): GenericGenomicRDD[(Option[Feature], Option[X])]

    Permalink

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

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

    In a sort-merge join, both RDDs 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 RDD does not overlap any values in the other RDD, it will be paired with a None in the product of the join.

    genomicRdd

    The right RDD in the join.

    returns

    Returns a new genomic RDD 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
    GenomicRDD
  23. def fullOuterShuffleRegionJoin[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y], flankSize: Long)(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], otoxTag: ClassTag[(Option[Feature], Option[X])]): GenericGenomicRDD[(Option[Feature], Option[X])]

    Permalink

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

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

    In a sort-merge join, both RDDs 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 RDD does not overlap any values in the other RDD, it will be paired with a None in the product of the join.

    genomicRdd

    The right RDD 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 RDD 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
    GenomicRDD
  24. final def getClass(): Class[_]

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

    Permalink

    elem

    The Feature to get an underlying region for.

    returns

    Since a feature maps directly to a single genomic region, this method will always return a Seq of exactly one ReferenceRegion.

    Attributes
    protected
    Definition Classes
    FeatureRDDGenomicRDD
  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  27. def isSorted: Boolean

    Permalink
    Definition Classes
    GenomicRDD
  28. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  29. lazy val jrdd: JavaRDD[Feature]

    Permalink

    The underlying RDD of genomic data, as a JavaRDD.

    The underlying RDD of genomic data, as a JavaRDD.

    Definition Classes
    GenomicRDD
  30. def leftOuterShuffleRegionJoin[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y])(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], toxTag: ClassTag[(Feature, Option[X])]): GenericGenomicRDD[(Feature, Option[X])]

    Permalink

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

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

    In a sort-merge join, both RDDs 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 RDD that do not overlap a value from the left RDD are dropped. If a value from the left RDD does not overlap any values in the right RDD, it will be paired with a None in the product of the join.

    genomicRdd

    The right RDD in the join.

    returns

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

    Definition Classes
    GenomicRDD
  31. def leftOuterShuffleRegionJoin[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y], flankSize: Long)(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], toxTag: ClassTag[(Feature, Option[X])]): GenericGenomicRDD[(Feature, Option[X])]

    Permalink

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

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

    In a sort-merge join, both RDDs 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 RDD that do not overlap a value from the left RDD are dropped. If a value from the left RDD does not overlap any values in the right RDD, it will be paired with a None in the product of the join.

    genomicRdd

    The right RDD 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 RDD containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the left RDD that did not overlap a key in the right RDD.

    Definition Classes
    GenomicRDD
  32. def leftOuterShuffleRegionJoinAndGroupByLeft[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y])(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], toxTag: ClassTag[(Feature, Iterable[X])]): GenericGenomicRDD[(Feature, Iterable[X])]

    Permalink

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

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

    In a sort-merge join, both RDDs 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 RDD that do not overlap a value from the left RDD are dropped. If a value from the left RDD does not overlap any values in the right RDD, it will be paired with an empty Iterable in the product of the join.

    genomicRdd

    The right RDD in the join.

    returns

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

    Definition Classes
    GenomicRDD
  33. def leftOuterShuffleRegionJoinAndGroupByLeft[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y], flankSize: Long)(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], toxTag: ClassTag[(Feature, Iterable[X])]): GenericGenomicRDD[(Feature, Iterable[X])]

    Permalink

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

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

    In a sort-merge join, both RDDs 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 RDD that do not overlap a value from the left RDD are dropped. If a value from the left RDD does not overlap any values in the right RDD, it will be paired with an empty Iterable in the product of the join.

    genomicRdd

    The right RDD 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 RDD containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the left RDD that did not overlap a key in the right RDD.

    Definition Classes
    GenomicRDD
  34. def log: Logger

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  41. def logName: String

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    RDDBoundFeatureRDDGenomicRDD
  50. def pipe[X, Y <: GenomicRDD[X, Y], V <: InFormatter[Feature, FeatureRDD, V]](cmd: String, files: List[String], environment: Map[String, String], flankSize: Integer, tFormatter: Class[V], xFormatter: OutFormatter[X], convFn: Function2[FeatureRDD, RDD[X], Y]): Y

    Permalink

    Pipes genomic data to a subprocess that runs in parallel using Spark.

    Pipes genomic data to a subprocess that runs in parallel using Spark.

    Java/PySpark friendly variant.

    X

    The type of the record created by the piped command.

    Y

    A GenomicRDD containing X's.

    V

    The InFormatter to use for formatting the data being piped to the command.

    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 RDD.

    returns

    Returns a new GenomicRDD of type Y.

    Definition Classes
    GenomicRDD
  51. def pipe[X, Y <: GenomicRDD[X, Y], V <: InFormatter[Feature, FeatureRDD, V]](cmd: String, files: Seq[Any], environment: Map[Any, Any], flankSize: Double, tFormatter: Class[V], xFormatter: OutFormatter[X], convFn: Function2[FeatureRDD, RDD[X], Y]): Y

    Permalink

    Pipes genomic data to a subprocess that runs in parallel using Spark.

    Pipes genomic data to a subprocess that runs in parallel using Spark.

    SparkR friendly variant.

    X

    The type of the record created by the piped command.

    Y

    A GenomicRDD containing X's.

    V

    The InFormatter to use for formatting the data being piped to the command.

    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 RDD.

    returns

    Returns a new GenomicRDD of type Y.

    Definition Classes
    GenomicRDD
  52. def pipe[X, Y <: GenomicRDD[X, Y], V <: InFormatter[Feature, FeatureRDD, V]](cmd: String, files: Seq[String] = Seq.empty, environment: Map[String, String] = Map.empty, flankSize: Int = 0)(implicit tFormatterCompanion: InFormatterCompanion[Feature, FeatureRDD, V], xFormatter: OutFormatter[X], convFn: (FeatureRDD, RDD[X]) ⇒ Y, tManifest: ClassTag[Feature], xManifest: ClassTag[X]): Y

    Permalink

    Pipes genomic data to a subprocess that runs in parallel using Spark.

    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 GenomicRDD. 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 GenomicRDD containing X's.

    V

    The InFormatter to use for formatting the data being piped to the command.

    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.

    returns

    Returns a new GenomicRDD of type Y.

    Definition Classes
    GenomicRDD
  53. val rdd: RDD[Feature]

    Permalink

    The RDD of genomic data that we are wrapping.

    The RDD of genomic data that we are wrapping.

    Definition Classes
    RDDBoundFeatureRDDGenomicRDD → ADAMRDDFunctions
  54. def replaceRdd(newRdd: RDD[Feature], newPartitionMap: Option[Array[Option[(ReferenceRegion, ReferenceRegion)]]] = None): FeatureRDD

    Permalink

    newRdd

    The RDD to replace the underlying RDD with.

    returns

    Returns a new FeatureRDD with the underlying RDD replaced.

    Attributes
    protected
    Definition Classes
    FeatureRDDGenomicRDD
  55. def replaceSequences(newSequences: SequenceDictionary): FeatureRDD

    Permalink

    Replaces the sequence dictionary attached to a GenomicRDD.

    Replaces the sequence dictionary attached to a GenomicRDD.

    newSequences

    The new sequence dictionary to attach.

    returns

    Returns a new GenomicRDD with the sequences replaced.

    Definition Classes
    RDDBoundFeatureRDDGenomicRDD
  56. def rightOuterBroadcastRegionJoin[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y])(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], otxTag: ClassTag[(Option[Feature], X)]): GenericGenomicRDD[(Option[Feature], X)]

    Permalink

    Performs a broadcast right outer join between this RDD and another RDD.

    Performs a broadcast right outer join between this RDD and another RDD.

    In a broadcast join, the left RDD (this RDD) 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 RDD that do not overlap a value from the right RDD are dropped. If a value from the right RDD does not overlap any values in the left RDD, it will be paired with a None in the product of the join.

    genomicRdd

    The right RDD in the join.

    returns

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

    Definition Classes
    GenomicRDD
    See also

    rightOuterBroadcastRegionJoin

  57. def rightOuterBroadcastRegionJoin[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y], flankSize: Long)(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], otxTag: ClassTag[(Option[Feature], X)]): GenericGenomicRDD[(Option[Feature], X)]

    Permalink

    Performs a broadcast right outer join between this RDD and another RDD.

    Performs a broadcast right outer join between this RDD and another RDD.

    In a broadcast join, the left RDD (this RDD) 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 RDD that do not overlap a value from the right RDD are dropped. If a value from the right RDD does not overlap any values in the left RDD, it will be paired with a None in the product of the join.

    genomicRdd

    The right RDD 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 RDD containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the right RDD that did not overlap a key in the left RDD.

    Definition Classes
    GenomicRDD
    See also

    rightOuterBroadcastRegionJoin

  58. def rightOuterBroadcastRegionJoinAgainst[X](broadcastTree: Broadcast[IntervalArray[ReferenceRegion, X]])(implicit tTag: ClassTag[Feature], xTag: ClassTag[X]): GenericGenomicRDD[(Option[X], Feature)]

    Permalink

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

    Performs a broadcast right outer join between this RDD 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 RDD are dropped. If a value from the right RDD 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.

    broadcastTree

    The data on the left side of the join.

    returns

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

    Definition Classes
    GenomicRDD
    Note

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

    See also

    rightOuterBroadcastRegionJoin

  59. def rightOuterBroadcastRegionJoinAgainstAndGroupByRight[X, Y <: GenomicRDD[X, Y]](broadcastTree: Broadcast[IntervalArray[ReferenceRegion, X]])(implicit tTag: ClassTag[Feature], xTag: ClassTag[X]): GenericGenomicRDD[(Iterable[X], Feature)]

    Permalink

    Performs a broadcast right outer join between this RDD and another RDD.

    Performs a broadcast right outer join between this RDD and another RDD.

    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 RDD are dropped. If a value from the right RDD 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.

    broadcastTree

    The data on the left side of the join.

    returns

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

    Definition Classes
    GenomicRDD
    Note

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

    See also

    rightOuterBroadcastRegionJoinAndGroupByRight

  60. def rightOuterBroadcastRegionJoinAndGroupByRight[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y])(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], itxTag: ClassTag[(Iterable[Feature], X)]): GenericGenomicRDD[(Iterable[Feature], X)]

    Permalink

    Performs a broadcast right outer join between this RDD and another RDD.

    Performs a broadcast right outer join between this RDD and another RDD.

    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 RDD that do not overlap a value from the right RDD are dropped. If a value from the right RDD does not overlap any values in the left RDD, it will be paired with a None in the product of the join.

    genomicRdd

    The right RDD in the join.

    returns

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

    Definition Classes
    GenomicRDD
    See also

    rightOuterBroadcastRegionJoinAgainstAndGroupByRight

  61. def rightOuterBroadcastRegionJoinAndGroupByRight[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y], flankSize: Long)(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], itxTag: ClassTag[(Iterable[Feature], X)]): GenericGenomicRDD[(Iterable[Feature], X)]

    Permalink

    Performs a broadcast right outer join between this RDD and another RDD.

    Performs a broadcast right outer join between this RDD and another RDD.

    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 RDD that do not overlap a value from the right RDD are dropped. If a value from the right RDD does not overlap any values in the left RDD, it will be paired with a None in the product of the join.

    genomicRdd

    The right RDD 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 RDD containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the right RDD that did not overlap a key in the left RDD.

    Definition Classes
    GenomicRDD
    See also

    rightOuterBroadcastRegionJoinAgainstAndGroupByRight

  62. def rightOuterShuffleRegionJoin[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y])(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], otxTag: ClassTag[(Option[Feature], X)]): GenericGenomicRDD[(Option[Feature], X)]

    Permalink

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

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

    In a sort-merge join, both RDDs 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 RDD that do not overlap a value from the right RDD are dropped. If a value from the right RDD does not overlap any values in the left RDD, it will be paired with a None in the product of the join.

    genomicRdd

    The right RDD in the join.

    returns

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

    Definition Classes
    GenomicRDD
  63. def rightOuterShuffleRegionJoin[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y], flankSize: Long)(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], otxTag: ClassTag[(Option[Feature], X)]): GenericGenomicRDD[(Option[Feature], X)]

    Permalink

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

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

    In a sort-merge join, both RDDs 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 RDD that do not overlap a value from the right RDD are dropped. If a value from the right RDD does not overlap any values in the left RDD, it will be paired with a None in the product of the join.

    genomicRdd

    The right RDD 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 RDD containing all pairs of keys that overlapped in the genomic coordinate space, and all keys from the right RDD that did not overlap a key in the left RDD.

    Definition Classes
    GenomicRDD
  64. def rightOuterShuffleRegionJoinAndGroupByLeft[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y])(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], otixTag: ClassTag[(Option[Feature], Iterable[X])]): GenericGenomicRDD[(Option[Feature], Iterable[X])]

    Permalink

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

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

    In a sort-merge join, both RDDs 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 RDD. Since this is a right outer join, all values from the right RDD who did not overlap a value from the left RDD are placed into a length-1 Iterable with a None key.

    genomicRdd

    The right RDD in the join.

    returns

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

    Definition Classes
    GenomicRDD
  65. def rightOuterShuffleRegionJoinAndGroupByLeft[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y], flankSize: Long)(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], otixTag: ClassTag[(Option[Feature], Iterable[X])]): GenericGenomicRDD[(Option[Feature], Iterable[X])]

    Permalink

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

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

    In a sort-merge join, both RDDs 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 RDD. Since this is a right outer join, all values from the right RDD who did not overlap a value from the left RDD are placed into a length-1 Iterable with a None key.

    genomicRdd

    The right RDD 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 RDD containing all pairs of keys that overlapped in the genomic coordinate space, grouped together by the value they overlapped in the left RDD, and all values from the right RDD that did not overlap an item in the left RDD.

    Definition Classes
    GenomicRDD
  66. def save(filePath: String, asSingleFile: Boolean, disableFastConcat: Boolean): Unit

    Permalink

    Java friendly save function.

    Java friendly save function. Automatically detects the output format.

    Writes files ending in .bed as BED6/12, .gff3 as GFF3, .gtf/.gff as GTF/GFF2, .narrow[pP]eak as NarrowPeak, and .interval_list as IntervalList. If none of these match, we fall back to Parquet. These files are written as sharded text files.

    filePath

    The location to write the output.

    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.

    disableFastConcat

    If asSingleFile is true, disables the use of the fast file concatenation engine.

    Definition Classes
    FeatureRDD
  67. def saveAsBed(fileName: String, asSingleFile: Boolean = false, disableFastConcat: Boolean = false): Unit

    Permalink

    Save this FeatureRDD in BED format.

    Save this FeatureRDD in BED format.

    fileName

    The path to save BED formatted text file(s) to.

    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
    FeatureRDD
  68. def saveAsGff3(fileName: String, asSingleFile: Boolean = false, disableFastConcat: Boolean = false): Unit

    Permalink

    Save this FeatureRDD in GFF3 format.

    Save this FeatureRDD in GFF3 format.

    fileName

    The path to save GFF3 formatted text file(s) to.

    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
    FeatureRDD
  69. def saveAsGtf(fileName: String, asSingleFile: Boolean = false, disableFastConcat: Boolean = false): Unit

    Permalink

    Save this FeatureRDD in GTF format.

    Save this FeatureRDD in GTF format.

    fileName

    The path to save GTF formatted text file(s) to.

    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
    FeatureRDD
  70. def saveAsIntervalList(fileName: String, asSingleFile: Boolean = false, disableFastConcat: Boolean = false): Unit

    Permalink

    Save this FeatureRDD in interval list format.

    Save this FeatureRDD in interval list format.

    fileName

    The path to save interval list formatted text file(s) to.

    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
    FeatureRDD
  71. def saveAsNarrowPeak(fileName: String, asSingleFile: Boolean = false, disableFastConcat: Boolean = false): Unit

    Permalink

    Save this FeatureRDD in NarrowPeak format.

    Save this FeatureRDD in NarrowPeak format.

    fileName

    The path to save NarrowPeak formatted text file(s) to.

    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
    FeatureRDD
  72. def saveAsParquet(filePath: String): Unit

    Permalink

    Saves this RDD to disk as a Parquet file.

    Saves this RDD to disk as a Parquet file.

    filePath

    Path to save the file at.

    Definition Classes
    AvroGenomicRDD
  73. def saveAsParquet(filePath: String, blockSize: Integer, pageSize: Integer, compressCodec: CompressionCodecName, disableDictionaryEncoding: Boolean): Unit

    Permalink

    Saves this RDD to disk as a Parquet file.

    Saves this RDD to disk as a Parquet file.

    filePath

    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.

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

    Permalink

    Saves this RDD to disk as a Parquet file.

    Saves this RDD to disk as a Parquet file.

    filePath

    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
    AvroGenomicRDD
  75. def saveAsParquet(args: SaveArgs): Unit

    Permalink

    Saves RDD as a directory of Parquet files.

    Saves RDD as a directory of Parquet files.

    The RDD is written as a directory of Parquet files, with Parquet configuration described by the input param args. The provided sequence dictionary is written at args.outputPath/_seqdict.avro as Avro binary.

    args

    Save configuration arguments.

    Definition Classes
    AvroGenomicRDD
  76. 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
    ADAMRDDFunctions
  77. def saveMetadata(filePath: String): Unit

    Permalink

    Called in saveAsParquet after saving RDD to Parquet to save metadata.

    Called in saveAsParquet after saving RDD to Parquet to save metadata.

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

    filePath

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

    Attributes
    protected
    Definition Classes
    AvroGenomicRDD
  78. def savePartitionMap(filePath: 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.

    filePath

    The filepath where we will save the partition map.

    Attributes
    protected
    Definition Classes
    AvroGenomicRDD
  79. 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 an RDD of Avro data to Parquet.

    Saves an RDD 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
    ADAMRDDFunctions
  80. def saveRddAsParquet(args: SaveArgs): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ADAMRDDFunctions
  81. def saveSequences(filePath: String): Unit

    Permalink

    Save the sequence dictionary to disk.

    Save the sequence dictionary to disk.

    filePath

    The filepath where we will save the sequence dictionary.

    Attributes
    protected
    Definition Classes
    AvroGenomicRDD
  82. val sequences: SequenceDictionary

    Permalink

    The sequence dictionary describing the reference assembly this dataset is aligned to.

    The sequence dictionary describing the reference assembly this dataset is aligned to.

    Definition Classes
    RDDBoundFeatureRDDGenomicRDD
  83. def shuffleRegionJoin[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y])(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], txTag: ClassTag[(Feature, X)]): GenericGenomicRDD[(Feature, X)]

    Permalink

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

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

    In a sort-merge join, both RDDs 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 RDD are dropped.

    genomicRdd

    The right RDD in the join.

    returns

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

    Definition Classes
    GenomicRDD
  84. def shuffleRegionJoin[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y], flankSize: Long)(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], txTag: ClassTag[(Feature, X)]): GenericGenomicRDD[(Feature, X)]

    Permalink

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

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

    In a sort-merge join, both RDDs 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 RDD are dropped.

    genomicRdd

    The right RDD 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 RDD containing all pairs of keys that overlapped in the genomic coordinate space.

    Definition Classes
    GenomicRDD
  85. def shuffleRegionJoinAndGroupByLeft[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y])(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], tixTag: ClassTag[(Feature, Iterable[X])]): GenericGenomicRDD[(Feature, Iterable[X])]

    Permalink

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

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

    In a sort-merge join, both RDDs 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 RDD are dropped. In the same operation, we group all values by the left item in the RDD.

    genomicRdd

    The right RDD in the join.

    returns

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

    Definition Classes
    GenomicRDD
  86. def shuffleRegionJoinAndGroupByLeft[X, Y <: GenomicRDD[X, Y]](genomicRdd: GenomicRDD[X, Y], flankSize: Long)(implicit tTag: ClassTag[Feature], xTag: ClassTag[X], tixTag: ClassTag[(Feature, Iterable[X])]): GenericGenomicRDD[(Feature, Iterable[X])]

    Permalink

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

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

    In a sort-merge join, both RDDs 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 RDD are dropped. In the same operation, we group all values by the left item in the RDD.

    genomicRdd

    The right RDD 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 RDD containing all pairs of keys that overlapped in the genomic coordinate space, grouped together by the value they overlapped in the left RDD..

    Definition Classes
    GenomicRDD
  87. def sort(partitions: Int = rdd.partitions.length, stringency: ValidationStringency = ValidationStringency.STRICT)(implicit tTag: ClassTag[Feature]): FeatureRDD

    Permalink

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

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

    partitions

    The number of partitions for the new RDD.

    stringency

    The level of ValidationStringency to enforce.

    returns

    Returns a new RDD containing sorted data.

    Definition Classes
    GenomicRDD
    Note

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

    See also

    sortLexicographically

  88. def sort(): FeatureRDD

    Permalink

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

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

    returns

    Returns a new RDD containing sorted data.

    Definition Classes
    GenomicRDD
    See also

    sortLexicographically

  89. def sortByReference(ascending: Boolean = true, numPartitions: Int = rdd.partitions.length): FeatureRDD

    Permalink

    Sorts the RDD by the reference ordering.

    Sorts the RDD by the reference ordering.

    ascending

    Whether to sort in ascending order or not.

    numPartitions

    The number of partitions to have after sorting. Defaults to the partition count of the underlying RDD.

    Definition Classes
    FeatureRDD
  90. def sortLexicographically(partitions: Int = rdd.partitions.length, storePartitionMap: Boolean = false, storageLevel: StorageLevel = StorageLevel.MEMORY_ONLY, stringency: ValidationStringency = ValidationStringency.STRICT)(implicit tTag: ClassTag[Feature]): FeatureRDD

    Permalink

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

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

    partitions

    The number of partitions for the new RDD.

    storePartitionMap

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

    storageLevel

    The level at which to persist the resulting RDD.

    stringency

    The level of ValidationStringency to enforce.

    returns

    Returns a new RDD containing sorted data.

    Definition Classes
    GenomicRDD
    Note

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

    See also

    sort

  91. def sortLexicographically(): FeatureRDD

    Permalink

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

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

    returns

    Returns a new RDD containing sorted data.

    Definition Classes
    GenomicRDD
    See also

    sort

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

    Permalink
    Definition Classes
    AnyRef
  93. def toCoverage(): CoverageRDD

    Permalink

    Converts the FeatureRDD to a CoverageRDD.

    Converts the FeatureRDD to a CoverageRDD.

    returns

    CoverageRDD containing RDD of Coverage.

    Definition Classes
    RDDBoundFeatureRDDFeatureRDD
  94. def toDF(): DataFrame

    Permalink

    returns

    This data as a Spark SQL DataFrame.

    Definition Classes
    GenomicDataset
  95. def toString(): String

    Permalink
    Definition Classes
    GenomicRDD → AnyRef → Any
  96. def transform(tFn: Function[JavaRDD[Feature], JavaRDD[Feature]]): FeatureRDD

    Permalink

    Applies a function that transforms the underlying RDD into a new RDD.

    Applies a function that transforms the underlying RDD into a new RDD.

    tFn

    A function that transforms the underlying RDD.

    returns

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

    Definition Classes
    GenomicRDD
  97. def transform(tFn: (RDD[Feature]) ⇒ RDD[Feature]): FeatureRDD

    Permalink

    Applies a function that transforms the underlying RDD into a new RDD.

    Applies a function that transforms the underlying RDD into a new RDD.

    tFn

    A function that transforms the underlying RDD.

    returns

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

    Definition Classes
    GenomicRDD
  98. def transformDataFrame(tFn: Function[DataFrame, DataFrame]): FeatureRDD

    Permalink

    Applies a function that transforms the underlying DataFrame into a new DataFrame using the Spark SQL API.

    Applies a function that transforms the underlying DataFrame into a new DataFrame using the Spark SQL API. Java-friendly variant.

    tFn

    A function that transforms the underlying RDD as a DataFrame.

    returns

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

    Definition Classes
    GenomicDataset
  99. def transformDataFrame(tFn: (DataFrame) ⇒ DataFrame)(implicit uTag: scala.reflect.api.JavaUniverse.TypeTag[Feature]): FeatureRDD

    Permalink

    Applies a function that transforms the underlying DataFrame into a new DataFrame using the Spark SQL API.

    Applies a function that transforms the underlying DataFrame into a new DataFrame using the Spark SQL API.

    tFn

    A function that transforms the underlying RDD as a DataFrame.

    returns

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

    Definition Classes
    GenomicDataset
  100. def transformDataset(tFn: (Dataset[Feature]) ⇒ Dataset[Feature]): FeatureRDD

    Permalink

    Applies a function that transforms the underlying RDD into a new RDD using the Spark SQL API.

    Applies a function that transforms the underlying RDD into a new RDD using the Spark SQL API.

    tFn

    A function that transforms the underlying RDD as a Dataset.

    returns

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

    Definition Classes
    FeatureRDDGenomicDataset
  101. def transmute[X, Y <: GenomicRDD[X, Y]](tFn: Function[JavaRDD[Feature], JavaRDD[X]], convFn: Function2[FeatureRDD, RDD[X], Y]): Y

    Permalink

    Applies a function that transmutes the underlying RDD into a new RDD of a different type.

    Applies a function that transmutes the underlying RDD into a new RDD of a different type. Java friendly version.

    tFn

    A function that transforms the underlying RDD.

    convFn

    The conversion function used to build the final RDD.

    returns

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

    Definition Classes
    GenomicRDD
  102. def transmute[X, Y <: GenomicRDD[X, Y]](tFn: (RDD[Feature]) ⇒ RDD[X])(implicit convFn: (FeatureRDD, RDD[X]) ⇒ Y): Y

    Permalink

    Applies a function that transmutes the underlying RDD into a new RDD of a different type.

    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 RDD where the RDD of genomic data has been replaced, but the metadata (sequence dictionary, and etc) is copied without modification.

    Definition Classes
    GenomicRDD
  103. def transmuteDataFrame[X <: Product, Y <: GenomicDataset[_, X, Y]](tFn: Function[DataFrame, DataFrame], convFn: GenomicDatasetConversion[Feature, FeatureRDD, X, Y]): Y

    Permalink

    Applies a function that transmutes the underlying RDD into a new RDD of a different type.

    Applies a function that transmutes the underlying RDD into a new RDD of a different type. Java friendly variant.

    tFn

    A function that transforms the underlying RDD.

    returns

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

    Definition Classes
    GenomicDataset
  104. def transmuteDataFrame[X <: Product, Y <: GenomicDataset[_, X, Y]](tFn: (DataFrame) ⇒ DataFrame)(implicit xTag: scala.reflect.api.JavaUniverse.TypeTag[X], convFn: (FeatureRDD, Dataset[X]) ⇒ Y): Y

    Permalink

    Applies a function that transmutes the underlying RDD into a new RDD of a different type.

    Applies a function that transmutes the underlying RDD into a new RDD of a different type. Java friendly variant.

    tFn

    A function that transforms the underlying RDD.

    returns

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

    Definition Classes
    GenomicDataset
  105. def transmuteDataset[X <: Product, Y <: GenomicDataset[_, X, Y]](tFn: Function[Dataset[Feature], Dataset[X]], convFn: GenomicDatasetConversion[Feature, FeatureRDD, X, Y]): Y

    Permalink

    Applies a function that transmutes the underlying RDD into a new RDD of a different type.

    Applies a function that transmutes the underlying RDD into a new RDD of a different type. Java friendly variant.

    tFn

    A function that transforms the underlying RDD.

    returns

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

    Definition Classes
    GenomicDataset
  106. def transmuteDataset[X <: Product, Y <: GenomicDataset[_, X, Y]](tFn: (Dataset[Feature]) ⇒ Dataset[X])(implicit xTag: scala.reflect.api.JavaUniverse.TypeTag[X], convFn: (FeatureRDD, Dataset[X]) ⇒ Y): Y

    Permalink

    Applies a function that transmutes the underlying RDD into a new RDD of a different type.

    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 RDD where the RDD of genomic data has been replaced, but the metadata (sequence dictionary, and etc) is copied without modification.

    Definition Classes
    GenomicDataset
  107. val uTag: scala.reflect.api.JavaUniverse.TypeTag[Feature]

    Permalink
    Definition Classes
    FeatureRDDGenomicDataset
  108. def union(rdds: FeatureRDD*): FeatureRDD

    Permalink

    Unions together multiple genomic RDDs.

    Unions together multiple genomic RDDs.

    rdds

    RDDs to union with this RDD.

    Definition Classes
    FeatureRDDGenomicRDD
  109. def union(rdds: List[FeatureRDD]): FeatureRDD

    Permalink

    Unions together multiple genomic RDDs.

    Unions together multiple genomic RDDs.

    rdds

    RDDs to union with this RDD.

    Definition Classes
    GenomicRDD
  110. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  113. 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
    GenomicRDD

Inherited from Product

Inherited from Equals

Inherited from FeatureRDD

Inherited from AvroGenomicRDD[Feature, Feature, FeatureRDD]

Inherited from GenomicDataset[Feature, Feature, FeatureRDD]

Inherited from GenomicRDD[Feature, FeatureRDD]

Inherited from ADAMRDDFunctions[Feature]

Inherited from Logging

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped