Skip to main content

Crate fgumi_metrics

Crate fgumi_metrics 

Source
Expand description

Structured metric types and TSV writer for fgumi operations.

This crate provides:

  • Metric and ProcessingMetrics traits for extensible metric types
  • Metric structs for consensus, grouping, correction, and duplex operations
  • rejection module for rejection reason tracking
  • writer module 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 clip command.
consensus
Metrics for consensus calling commands.
correct
Metrics for the correct command.
duplex
Metrics for the duplex_metrics command.
group
Metrics for the group command.
rejection
Rejection reason tracking for reads and templates.
shared
Shared UMI tracking types used across simplex and duplex metrics.
simplex
Metrics for the simplex-metrics command.
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.
ProcessingMetrics
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 / denominator for u64 values, returning 0.0 if denominator is zero.