Expand description
Structured metric types and TSV writer for fgumi operations.
This crate provides:
MetricandProcessingMetricstraits for extensible metric types- Metric structs for consensus, grouping, correction, and duplex operations
rejectionmodule for rejection reason trackingwritermodule for TSV file output
Re-exports§
pub use clip::ClipCounts;pub use clip::ClippingMetrics;pub use clip::ClippingMetricsCollection;pub use clip::ReadType;pub use consensus::ConsensusKvMetric;pub use consensus::ConsensusMetrics;pub use correct::UmiCorrectionMetrics;pub use duplex::DuplexFamilySizeMetric;pub use duplex::DuplexMetricsCollector;pub use duplex::DuplexUmiMetric;pub use duplex::DuplexYieldMetric;pub use duplex::FamilySizeMetric;pub use group::FamilySizeMetrics;pub use group::PositionGroupSizeMetrics;pub use group::UmiGroupingMetrics;pub use rejection::RejectionReason;pub use rejection::format_count;pub use shared::UmiMetric;pub use simplex::SimplexFamilySizeMetric;pub use simplex::SimplexMetricsCollector;pub use simplex::SimplexYieldMetric;pub use writer::read_metrics;pub use writer::read_metrics_auto;pub use writer::write_metrics;
Modules§
- clip
- Clipping metrics for the
clipcommand. - consensus
- Metrics for consensus calling commands.
- correct
- Metrics for the
correctcommand. - duplex
- Metrics for the
duplex_metricscommand. - group
- Metrics for the
groupcommand. - rejection
- Rejection reason tracking for reads and templates.
- shared
- Shared UMI tracking types used across simplex and duplex metrics.
- simplex
- Metrics for the
simplex-metricscommand. - writer
- Utilities for writing metrics files.
Constants§
- FLOAT_
PRECISION - Number of decimal places used for float metrics (matches fgbio).
Traits§
- Metric
- A metric type that can be serialized to TSV files.
- Processing
Metrics - Common interface for metrics that track processing pipeline counts.
Functions§
- format_
float - Formats a float value with the standard precision for metrics.
- frac
- Computes
numerator / denominator, returning 0.0 if the denominator is zero. - frac_
u64 - Computes
numerator / denominatorforu64values, returning 0.0 if denominator is zero.