Underlying RDD
Sequence dictionary computed from rdd
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.
The right RDD in the join.
Returns a new genomic RDD containing all pairs of keys that overlapped in the genomic coordinate space.
Counts the k-mers contained in a FASTA contig.
Counts the k-mers contained in a FASTA contig.
The length of k-mers to count.
Returns an RDD containing k-mer/count pairs.
From a set of contigs, returns the base sequence that corresponds to a region of the reference.
From a set of contigs, returns the base sequence that corresponds to a region of the reference.
Reference region over which to get sequence.
String of bases corresponding to reference sequence.
Throws exception if query region is not found.
For all adjacent records in the RDD, we extend the records so that the adjacent records now overlap by _n_ bases, where _n_ is the flank length.
For all adjacent records in the RDD, we extend the records so that the adjacent records now overlap by _n_ bases, where _n_ is the flank length.
The length to extend adjacent records by.
Returns the RDD, with all adjacent fragments extended with flanking sequence.
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.
The right RDD in the join.
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
.
Fragment to extract a region from.
If a fragment is aligned to a reference location, returns a single reference region. If the fragment start position and name is not defined, returns no regions.
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.
The right RDD in the join.
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.
Merge fragments by contig name.
Merge fragments by contig name.
Returns a NucleotideContigFragmentRDD containing a single fragment per contig.
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.
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.
The type of the record created by the piped command.
A GenomicRDD containing X's.
The InFormatter to use for formatting the data being piped to the command.
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.
Returns a new GenomicRDD of type Y.
Underlying RDD
Underlying RDD
Replaces the underlying RDD with a new RDD.
Replaces the underlying RDD with a new RDD.
The RDD to use for the new NucleotideContigFragmentRDD.
Returns a new NucleotideContigFragmentRDD where the underlying RDD has been replaced.
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.
The right RDD in the join.
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.
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.
The right RDD in the join.
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.
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.
The right RDD in the join.
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.
Save nucleotide contig fragments as Parquet or FASTA.
Save nucleotide contig fragments as Parquet or FASTA.
If filename ends in .fa or .fasta, saves as Fasta. If not, saves fragments to Parquet. Defaults to 60 character line length, if saving to FASTA.
file name
Save nucleotide contig fragments in FASTA format.
Save nucleotide contig fragments in FASTA format.
file name
hard wrap FASTA formatted sequence at line width, default 60
Saves this RDD to disk as a Parquet file.
Saves this RDD to disk as a Parquet file.
Path to save the file at.
Saves this RDD to disk as a Parquet file.
Saves this RDD to disk as a Parquet file.
Path to save the file at.
Size per block.
Size per page.
Name of the compression codec to use.
Whether or not to disable bit-packing.
Saves this RDD to disk as a Parquet file.
Saves this RDD to disk as a Parquet file.
Path to save the file at.
Size per block.
Size per page.
Name of the compression codec to use.
Whether or not to disable bit-packing. Default is false.
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.
Save configuration arguments.
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.
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.
Sequence dictionary computed from rdd
Sequence dictionary computed from rdd
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.
The right RDD in the join.
Returns a new genomic RDD containing all pairs of keys that overlapped in the genomic coordinate space.
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.
The right RDD in the join.
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..
Converts an RDD of nucleotide contig fragments into reads.
Converts an RDD of nucleotide contig fragments into reads. Adjacent contig fragments are combined.
Returns an RDD of reads.
A wrapper class for RDD[NucleotideContigFragment]. NucleotideContigFragmentRDD extends ReferenceFile. To specifically access a ReferenceFile within an RDD, refer to:
Underlying RDD
Sequence dictionary computed from rdd
ReferenceContigMap