MultisampleGenomicDataset
Related Doc:
package rdd
These data as a Spark SQL Dataset.
These data as a Spark SQL Dataset.
The RDD of genomic data that we are wrapping.
The RDD of genomic data that we are wrapping.
Replaces the sample metadata attached to the genomic dataset.
Replaces the sample metadata attached to the genomic dataset.
The new sample metadata to attach.
A GenomicDataset with new sample metadata.
Replaces the sequence dictionary attached to a GenomicDataset.
Replaces the sequence dictionary attached to a GenomicDataset.
The new sequence dictionary to attach.
Returns a new GenomicDataset with the sequences replaced.
The samples who have data contained in this GenomicDataset.
Saves a genomic dataset to Parquet.
Saves a genomic dataset to Parquet.
The path to save the file to.
The size in bytes of blocks to write.
The size in bytes of pages to write.
The compression codec to apply to pages.
If false, dictionary encoding is used. If true, delta encoding is used.
The sequence dictionary describing the reference assembly this dataset is aligned to.
The sequence dictionary describing the reference assembly this dataset is aligned to.
(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.
A function that transforms the underlying Dataset as a Dataset.
A new genomic dataset where the Dataset of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.
(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.
A function that transforms the underlying Dataset as a Dataset.
A new genomic dataset where the Dataset of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.
(Scala-specific) Unions together multiple genomic datasets.
(Scala-specific) Unions together multiple genomic datasets.
Genomic datasets to union with this genomic dataset.
Adds a single sample to the current genomic dataset.
Adds a single sample to the current genomic dataset.
A single sample to add.
Returns a new genomic dataset with this sample added.
Adds samples to the current genomic dataset.
Adds samples to the current genomic dataset.
Zero or more samples to add.
Returns a new genomic dataset with samples added.
Appends metadata for a single sequence to the current genomic dataset.
Appends metadata for a single sequence to the current genomic dataset.
The sequence to add.
Returns a new GenomicDataset with this sequence appended.
Appends sequence metadata to the current genomic dataset.
Appends sequence metadata to the current genomic dataset.
The new sequences to append.
Returns a new GenomicDataset with the sequences appended.
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.
The right genomic dataset in the join.
Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.
broadcastRegionJoinAgainst
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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.
broadcastRegionJoinAgainst
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.
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.
The data on the left side of the join.
Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.
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.
broadcastRegionJoin
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.
The data on the left side of the join.
Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.
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.
broadcastRegionJoinAndGroupByRight
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.
The right genomic dataset in the join.
Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.
broadcastRegionJoinAgainstAndGroupByRight
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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.
broadcastRegionJoinAgainstAndGroupByRight
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.
broadcastRegionJoinAgainstAndGroupByRight
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.
broadcastRegionJoinAgainstAndGroupByRight
Caches underlying RDD in memory.
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.
The region to query for.
Returns a new GenomicDataset containing only data that overlaps the query region.
(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.
The regions to query for.
Returns a new GenomicDataset containing only data that overlaps the querys region.
(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.
The regions to query for.
Returns a new GenomicDataset containing only data that overlaps the querys region.
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.
The right genomic dataset in the join.
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.
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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
The underlying RDD of genomic data, as a JavaRDD.
The underlying RDD of genomic data, as a JavaRDD.
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.
The right genomic dataset in the join.
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.
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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
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.
The right genomic dataset in the join.
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.
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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
Persists underlying RDD in memory or disk.
Persists underlying RDD in memory or disk.
new StorageLevel
Persisted GenomicDataset.
(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.
The type of the record created by the piped command.
A GenomicDataset containing X's.
Command to run.
Files to make locally available to the commands being run. Default is empty.
A map containing environment variable/value pairs to set in the environment for the newly created process. Default is empty.
Number of bases to flank each command invocation by.
Class of formatter for data going into pipe command.
Formatter for data coming out of the pipe command.
The conversion function used to build the final genomic dataset.
Returns a new GenomicDataset of type Y.
(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.
The type of the record created by the piped command.
A GenomicDataset containing X's.
Command to run.
Files to make locally available to the commands being run. Default is empty.
A map containing environment variable/value pairs to set in the environment for the newly created process. Default is empty.
Number of bases to flank each command invocation by.
Class of formatter for data going into pipe command.
Formatter for data coming out of the pipe command.
The conversion function used to build the final genomic dataset.
Returns a new GenomicDataset of type Y.
(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.
The type of the record created by the piped command.
A GenomicDataset containing X's.
Command to run.
Files to make locally available to the commands being run. Default is empty.
A map containing environment variable/value pairs to set in the environment for the newly created process. Default is empty.
Number of bases to flank each command invocation by.
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 a new GenomicDataset of type Y.
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.
The right genomic dataset in the join.
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.
rightOuterBroadcastRegionJoin
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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
rightOuterBroadcastRegionJoin
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
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.
The data on the left side of the join.
Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.
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.
rightOuterBroadcastRegionJoin
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.
The data on the left side of the join.
Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.
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.
rightOuterBroadcastRegionJoinAndGroupByRight
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.
The right genomic dataset in the join.
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.
rightOuterBroadcastRegionJoinAgainstAndGroupByRight
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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
rightOuterBroadcastRegionJoinAgainstAndGroupByRight
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
rightOuterBroadcastRegionJoinAgainstAndGroupByRight
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
rightOuterBroadcastRegionJoinAgainstAndGroupByRight
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.
The right genomic dataset in the join.
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.
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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
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.
The right genomic dataset in the join.
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.
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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
Saves a genomic dataset to Parquet.
Saves a genomic dataset to Parquet.
The output format configuration to use when saving the data.
Saves this RDD to disk in range binned partitioned Parquet format.
Saves this RDD to disk in range binned partitioned Parquet format.
The path to save the partitioned Parquet file to.
Name of the compression codec to use.
Size of partitions used when writing Parquet, in base pairs (bp). Defaults to 1,000,000 bp.
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.
The type of the specific record we are saving.
Path to save records to.
SparkContext used for identifying underlying file system.
Schema of records we are saving.
Seq of records we are saving.
Writes any necessary metadata to disk.
Writes any necessary metadata to disk. If not overridden, writes the sequence dictionary to disk as Avro.
The path to save metadata to.
Save the samples to disk.
Save the samples to disk.
The path to save samples to.
Save the sequence dictionary to disk.
Save the sequence dictionary to disk.
The path to save the sequence dictionary to.
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.
The right genomic dataset in the join.
Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.
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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
Returns a new genomic dataset containing all pairs of keys that overlapped in the genomic coordinate space.
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.
The right genomic dataset in the join.
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.
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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
(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.
The right genomic dataset in the join.
Sets a flankSize for the distance between elements to be joined. If set to 0, an overlap is required to join two elements.
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.
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.
The number of partitions for the new genomic dataset.
The level of ValidationStringency to enforce.
Returns a new genomic dataset containing sorted data.
Uses ValidationStringency to handle unaligned or where objects align to multiple positions.
sortLexicographically
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 a new genomic dataset containing sorted data.
sortLexicographically
Sorts our genome aligned data by reference positions, with references ordered lexicographically.
Sorts our genome aligned data by reference positions, with references ordered lexicographically.
The number of partitions for the new genomic dataset.
A Boolean flag to determine whether to store the partition bounds from the resulting genomic dataset.
The level at which to persist the resulting genomic dataset.
The level of ValidationStringency to enforce.
Returns a new genomic dataset containing sorted data.
Uses ValidationStringency to handle data that is unaligned or where objects align to multiple positions.
sort
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 a new genomic dataset containing sorted data.
sort
These data as a Spark SQL DataFrame.
(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.
A function that transforms the underlying RDD.
A new genomic dataset where the RDD of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.
(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.
A function that transforms the underlying RDD.
A new genomic dataset where the RDD of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.
(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.
A function that transforms the underlying DataFrame as a DataFrame.
A new genomic dataset where the DataFrame of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.
(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.
A function that transforms the underlying data as a DataFrame.
A new genomic dataset where the DataFrame of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.
(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.
A function that transforms the underlying RDD.
The conversion function used to build the final RDD.
A new genomid dataset where the RDD of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.
(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.
A function that transforms the underlying RDD.
A new genomic dataset where the RDD of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.
(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.
A function that transforms the underlying DataFrame.
A new genomic dataset where the DataFrame of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.
(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.
A function that transforms the underlying DataFrame.
A new genomic dataset where the DataFrame of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.
(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.
A function that transforms the underlying Dataset.
A new genomic dataset where the Dataset of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.
(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.
A function that transforms the underlying Dataset.
A new genomic dataset where the Dataset of genomic data has been replaced, but the metadata (sequence dictionary, and etc) are copied without modification.
(Java-specific) Unions together multiple genomic datasets.
(Java-specific) Unions together multiple genomic datasets.
Genomic datasets to union with this genomic dataset.
Unpersists underlying RDD from memory or disk.
Unpersists underlying RDD from memory or disk.
Uncached GenomicDataset.
Writes an RDD to disk as text and optionally merges.
Writes an RDD to disk as text and optionally merges.
RDD to save.
Output path to save text files to.
If true, combines all partition shards.
If asSingleFile is true, disables the use of the parallel file merging engine.
If provided, the header file to include.
A trait describing a GenomicDataset with data from multiple samples.