obitools/obitools4
2
0
Fork 0
mirror of https://github.com/metabarcoding/obitools4.git synced 2026-04-30 12:00:39 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
841e5c9e2ac243b843671d22ef009dc876e76745
obitools4/autodoc/docmd/pkg/obiseq/paired_reads.md
T
Eric Coissac 8c7017a99d ⬆️ version bump to v4.5 
- Update obioptions.Version from "Release 4.4.29" to "/v/ Release v5"
- Update version.txt from 4.29 → .30
(automated by Makefile)
2026-04-13 13:34:53 +02:00

1.0 KiB
Raw Blame History

BioSequence Pairing Functionality

This package provides semantic tools for managing biological sequence pairings—typically used in genomics (e.g., paired-end reads). Key features:

  • Single-sequence pairing:

    • IsPaired() checks if a sequence is currently paired.
    • PairedWith() returns the linked partner, or nil.
    • PairTo(p) establishes a bidirectional link between two sequences.
    • UnPair() safely severs the pairing on both ends.

  • Batch (slice) handling:

    • IsPaired() and UnPair() operate uniformly across all sequences in a slice.
    • PairedWith() returns the corresponding paired slice (element-wise).
    • PairTo(p) enforces length compatibility and pairs sequences index-by-index.

  • Error handling:

    • Mismatched slice lengths during PairTo trigger a fatal log (via Logrus), preventing inconsistent pairings.

Semantically, the API supports both atomic and bulk pairing operations while preserving consistency through bidirectional references—ideal for processing paired-end sequencing data.

Reference in New Issue View Git Blame Copy Permalink