Struct noodles_sam::header::read_group::builder::Builder [−][src]
pub struct Builder { /* fields omitted */ }
Expand description
A SAM header reference read group.
Implementations
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");
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"));
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"));
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"));
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"));
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("*"));
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"));
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"));
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"));
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));
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));
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"));
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"));
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"));
Inserts a tag-raw value pair.
Examples
use noodles_sam::header::{read_group::Tag, ReadGroup};
let zn = Tag::Other([b'z', b'n']);
let read_group = ReadGroup::builder()
.set_id("rg0")
.insert(zn, String::from("noodles"))
.build()?;
assert_eq!(
read_group.fields().get(&zn),
Some(&String::from("noodles"))
);