Struct noodles_sam::header::read_group::builder::Builder

pub struct Builder { /* fields omitted */ }

A SAM header reference read group.

Implementations

impl Builder

pub fn set_id<I>(self, id: I) -> Self where
    I: Into<String>, 

Sets a read group ID.

Examples

use noodles_sam::header::ReadGroup;
let read_group = ReadGroup::builder().set_id("rg0").build()?;
assert_eq!(read_group.id(), "rg0");

pub fn set_barcode<I>(self, barcode: I) -> Self where
    I: Into<String>, 

Sets a barcode sequence.

Examples

use noodles_sam::header::ReadGroup;

let read_group = ReadGroup::builder()
    .set_id("rg0")
    .set_barcode("ACGT")
    .build()?;

assert_eq!(read_group.barcode(), Some("ACGT"));

pub fn set_sequencing_center<I>(self, sequencing_center: I) -> Self where
    I: Into<String>, 

Sets a sequencing center.

Examples

use noodles_sam::header::ReadGroup;

let read_group = ReadGroup::builder()
    .set_id("rg0")
    .set_sequencing_center("sc0")
    .build()?;

assert_eq!(read_group.sequencing_center(), Some("sc0"));

pub fn set_description<I>(self, description: I) -> Self where
    I: Into<String>, 

Sets a description.

Examples

use noodles_sam::header::ReadGroup;

let read_group = ReadGroup::builder()
    .set_id("rg0")
    .set_description("noodles")
    .build()?;

assert_eq!(read_group.description(), Some("noodles"));

pub fn set_produced_at<I>(self, produced_at: I) -> Self where
    I: Into<String>, 

Sets a datetime of run.

Examples

use noodles_sam::header::ReadGroup;

let read_group = ReadGroup::builder()
    .set_id("rg0")
    .set_produced_at("2020-08-19T20:00:00Z")
    .build()?;

assert_eq!(read_group.produced_at(), Some("2020-08-19T20:00:00Z"));

pub fn set_flow_order<I>(self, flow_order: I) -> Self where
    I: Into<String>, 

Sets a flow order.

Examples

use noodles_sam::header::ReadGroup;

let read_group = ReadGroup::builder()
    .set_id("rg0")
    .set_flow_order("*")
    .build()?;

assert_eq!(read_group.flow_order(), Some("*"));

pub fn set_key_sequence<I>(self, key_sequence: I) -> Self where
    I: Into<String>, 

Sets a key sequence.

Examples

use noodles_sam::header::ReadGroup;

let read_group = ReadGroup::builder()
    .set_id("rg0")
    .set_key_sequence("ACGT")
    .build()?;

assert_eq!(read_group.key_sequence(), Some("ACGT"));

pub fn set_library<I>(self, library: I) -> Self where
    I: Into<String>, 

Sets a library.

Examples

use noodles_sam::header::ReadGroup;

let read_group = ReadGroup::builder()
    .set_id("rg0")
    .set_library("sample0")
    .build()?;

assert_eq!(read_group.library(), Some("sample0"));

pub fn set_program<I>(self, program: I) -> Self where
    I: Into<String>, 

Sets a list of programs used.

Examples

use noodles_sam::header::ReadGroup;

let read_group = ReadGroup::builder()
    .set_id("rg0")
    .set_program("noodles")
    .build()?;

assert_eq!(read_group.program(), Some("noodles"));

pub fn set_predicted_median_insert_size(
    self,
    predicted_median_insert_size: i32
) -> Self

Sets a predicted median insert size.

Examples

use noodles_sam::header::ReadGroup;

let read_group = ReadGroup::builder()
    .set_id("rg0")
    .set_predicted_median_insert_size(101)
    .build()?;

assert_eq!(read_group.predicted_median_insert_size(), Some(101));

pub fn set_platform(self, platform: Platform) -> Self

Sets a platform.

Examples

use noodles_sam::header::{read_group::Platform, ReadGroup};

let read_group = ReadGroup::builder()
    .set_id("rg0")
    .set_platform(Platform::Illumina)
    .build()?;

assert_eq!(read_group.platform(), Some(Platform::Illumina));

pub fn set_platform_model<I>(self, platform_model: I) -> Self where
    I: Into<String>, 

Sets a platform model.

Examples

use noodles_sam::header::ReadGroup;

let read_group = ReadGroup::builder()
    .set_id("rg0")
    .set_platform_model("noodles")
    .build()?;

assert_eq!(read_group.platform_model(), Some("noodles"));

pub fn set_platform_unit<I>(self, platform_unit: I) -> Self where
    I: Into<String>, 

Sets a platform unit.

Examples

use noodles_sam::header::ReadGroup;

let read_group = ReadGroup::builder()
    .set_id("rg0")
    .set_platform_unit("NDLS000.1")
    .build()?;

assert_eq!(read_group.platform_unit(), Some("NDLS000.1"));

pub fn set_sample<I>(self, sample: I) -> Self where
    I: Into<String>, 

Sets a sample.

Examples

use noodles_sam::header::ReadGroup;

let read_group = ReadGroup::builder()
    .set_id("rg0")
    .set_sample("sample0")
    .build()?;

assert_eq!(read_group.sample(), Some("sample0"));

pub fn insert<I>(self, tag: Tag, value: I) -> Self where
    I: Into<String>, 

Inserts a tag-raw value pair.

Examples

use noodles_sam::header::{read_group::Tag, ReadGroup};

let zn = Tag::Other(String::from("zn"));

let read_group = ReadGroup::builder()
    .set_id("rg0")
    .insert(zn.clone(), String::from("noodles"))
    .build()?;

assert_eq!(
    read_group.fields().get(&zn),
    Some(&String::from("noodles"))
);

pub fn build(self) -> Result<ReadGroup, BuildError>

Builds a reference sequence.

Examples

use noodles_sam::header::ReadGroup;
let read_group = ReadGroup::builder().set_id("rg0").build()?;

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.