creating SAM file headers

Open
#3,235 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
cpp
Domain
documentation

Research direction

Start with the SAM/BAM handling tutorial at docs.seqan.de/seqan3/main_user/tutorial_sam_file.html and inspect the existing examples and relevant code APIs. Add examples covering creation, access, reference-sequence specification, and reuse or updating of headers from an existing file; the tutorial is done when these header workflows are explained with usable code.

Written by the indexing model from the issue text.

Description

documentation feature/proposal

The SAM/BAM handling tutorial (https://docs.seqan.de/seqan3/main_user/tutorial_sam_file.html) is quite helpful, but is missing examples on handling of SAM file headers: how to create them from scratch, how to access them, how to specify the reference sequences, how to reuse/update headers from an existing file. I was able to find most of this by searching the code, but it would be useful if these functions were included in the tutorial.

Dominant language
C++
Stars
463
Forks
90
Avg merge
1h 11m
Merged PRs (30d)
3

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from seqan/seqan3

All issues in seqan/seqan3

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.