package util
- Alphabetic
- Public
- All
Type Members
-
class
BetterBufferedIterator
[A] extends BufferedIterator[A]
A better buffered iterator that provides implementations of takeWhile and dropWhile that don't discard extra values.
-
class
DelimitedDataParser
extends Iterator[Row] with LazyLogging
A parser for files of text columns delimited by some character (e.g.
A parser for files of text columns delimited by some character (e.g. tab-delimited or csv).
- class DnaFoldPrediction extends AnyRef
-
class
DnaFoldPredictor
extends AnyRef
Class that wraps ViennaRNAs RNAFold utility which can be used to estimate the minimum free energy secondary structure of DNA and RNA molecules.
Class that wraps ViennaRNAs RNAFold utility which can be used to estimate the minimum free energy secondary structure of DNA and RNA molecules. When constructed a background process is started running RNAFold, calls to predict() then pipe input and output through RNAFold.
-
trait
GenomicSpan
extends Locatable
A simple trait that extends htsjdk.samtools.util.Locatable but provides a few easier to use methods for getting the location.
-
case class
IndexMetric
(index: String, source: String, min_mismatches: Int, indices_at_min_mismatches: Int, gc: Double, longest_homopolymer: Int, worst_structure_seq: Option[String], worst_structure_dbn: Option[String], worst_structure_delta_g: Option[Double]) extends Metric with Product with Serializable
A Metric class for information about each picked index.
-
class
Io
extends IoUtil
Provides common IO utility methods.
Provides common IO utility methods. Can be instantiated to create a custom factory, or the companion object can be used as a singleton version.
-
trait
Metric
extends Product
Base trait for metrics.
Base trait for metrics.
All classes extending this class should be a case class. By convention, all fields should be lower case with words separated by underscores.
-
case class
MolecularBarcode
(offset: Int, length: Int, symbol: Char = 'M') extends ReadSegment with Product with Serializable
Bases used to identify the source molecule
-
class
NumericCounter
[T] extends SimpleCounter[T]
Super-simple class for counting occurrences of any [Numeric].
Super-simple class for counting occurrences of any [Numeric]. Will return zero for any item that has not been counted yet. Implements some useful methods to compute statistics when the objects being counted are numeric types.
-
class
PickIlluminaIndices
extends FgBioTool
Program for picking sets of indices of arbitrary length that meet certain constraints and attempt to maximize the edit distance between all members of the set picked.
Program for picking sets of indices of arbitrary length that meet certain constraints and attempt to maximize the edit distance between all members of the set picked.
- Annotations
- @ClpAnnotation()
-
class
PickLongIndices
extends FgBioTool with LazyLogging
- Annotations
- @ClpAnnotation()
-
class
ProgressLogger
extends AbstractProgressLogger
A subclass of HTSJDK's progress logger that uses fgbio's logging system.
-
sealed
trait
ReadSegment
extends AnyRef
Base for all types of segments of a read
-
class
ReadStructure
extends Seq[ReadSegment]
Describes the structure of a give read.
Describes the structure of a give read. A read contains one or more read segments. A read segment describes a contiguous stretch of bases of the same type (ex. template bases) of some length and some offset from the start of the read.
-
class
RefFlatSource
extends Iterable[Gene] with Closeable with LazyLogging
Reads gene annotation information from a RefFlat file.
Reads gene annotation information from a RefFlat file.
Skips genes on unrecognized chromosomes if a sequence dictionary is provided.
The format is described here: http://genome.ucsc.edu/goldenPath/gbdDescriptionsOld.html#RefFlat
A Picard-style header is also supported (GENE_NAME, TRANSCRIPT_NAME, ...).
-
class
Row
extends AnyRef
Represents a row of parsed data.
Represents a row of parsed data. Provides methods for accessing values in a type-safe way either via apply() methods for non-optional fields or via get for optional fields.
-
case class
SampleBarcode
(offset: Int, length: Int, symbol: Char = 'B') extends ReadSegment with Product with Serializable
Bases used to identify the sample
-
case class
SampleBarcodeMetric
(barcode_name: String = "", library_name: String = "", barcode: String = "", reads: Int = 0, pf_reads: Int = 0, perfect_matches: Int = 0, pf_perfect_matches: Int = 0, one_mismatch_matches: Int = 0, pf_one_mismatch_matches: Int = 0, pct_matches: Double = 0d, ratio_this_barcode_to_best_barcode_pct: Double = 0d, pf_pct_matches: Double = 0d, pf_ratio_this_barcode_to_best_barcode_pct: Double = 0d, pf_normalized_matches: Double = 0d) extends Metric with Product with Serializable
Metrics for matching reads to sample barcodes.
-
class
SimpleCounter
[T] extends Iterable[(T, Long)]
Super-simple class for counting occurrences of any kind of object.
Super-simple class for counting occurrences of any kind of object. Will return zero for any item that has not been counted yet.
-
case class
Skip
(offset: Int, length: Int, symbol: Char = 'S') extends ReadSegment with Product with Serializable
Bases to ignore
-
case class
Template
(offset: Int, length: Int, symbol: Char = 'T') extends ReadSegment with Product with Serializable
Bases from the template
Value Members
- object DelimitedDataParser
-
object
GeneAnnotations
Stores classes useful for storing annotation information for genes and their transcripts and exons.
-
object
IlluminaAdapters
An object providing access to various Illumina adapter sequences.
-
object
Io
extends Io
Singleton object that can be used when the default buffer size and compression are desired.
-
object
MathUtil
Some simple utility methods for various mathematical operations that are implemented in efficient albeit non-idiomatic scala.
- object Metric
- object NumericCounter
-
object
NumericTypes
Container object for a set of numeric types for working with common probability scalings.
- object PickLongIndices
- object ReadSegment
- object ReadStructure
- object RefFlatSource
-
object
Rscript
extends LazyLogging
Object that enables running of R scripts via the Rscript command line too.
- object SampleBarcodeMetric extends Serializable
-
object
Sequences
Utility methods for working with DNA or RNA sequences
- object SimpleCounter