Struct Summary

pub struct Summary {
    pub conditions: HashMap<String, ConditionSummary>,
}

A struct representing a summary of conditions.

The Summary struct contains a hashmap where each key represents the name of a condition, and the corresponding value is a ConditionSummary struct containing the summary information for that condition.

Fields

• conditions - A hashmap containing the summary information for each condition. The key is a string representing the name of the condition, and the value is a ConditionSummary struct containing the summary information for that condition.

Examples

use std::collections::HashMap;
use readfish_tools::{Summary, ConditionSummary};

// Create a new Summary
let mut summary = Summary {
    conditions: HashMap::new(),
};

// Add some condition summaries
summary.conditions.insert(
    "ConditionA".to_string(),
    ConditionSummary {
        // ... fill in the details for ConditionA ...
    }
);

summary.conditions.insert(
    "ConditionB".to_string(),
    ConditionSummary {
        // ... fill in the details for ConditionB ...
    }
);

// Access a specific condition summary
if let Some(condition_summary) = summary.conditions.get("ConditionA") {
    println!("Summary for ConditionA: {:?}", condition_summary);
}

Fields

conditions: HashMap<String, ConditionSummary>

Conditions summary for a given region or barcode.

Implementations

impl Summary

pub fn conditions<T: Deref<Target = str>>( &mut self, condition_name: T, ) -> &mut ConditionSummary

Get the summary for the specified condition. If the condition does not exist in the Summary, it will be created with default values.

Arguments

• condition_name: A String representing the name or identifier of the condition.

Returns

A reference to the ConditionSummary for the specified condition.

Example

use std::collections::HashMap;

let mut summary = Summary::new();

// Get or add the condition with the name "Condition A"
let condition_a = summary.conditions("Condition A".to_string());

// Modify the fields of the condition summary
condition_a.set_total_reads(10000);
condition_a.set_on_target_read_count(8000);
condition_a.set_off_target_read_count(2000);
// ...

// Get or add another condition
let condition_b = summary.conditions("Condition B".to_string());
// ...

Trait Implementations

impl Debug for Summary

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Summary

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.