Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ALPHABET, DOC] Improve documentation of the quality alphabets #266

Closed
5 tasks done
smehringer opened this issue Nov 30, 2020 · 0 comments · Fixed by seqan/seqan3#2367
Closed
5 tasks done

[ALPHABET, DOC] Improve documentation of the quality alphabets #266

smehringer opened this issue Nov 30, 2020 · 0 comments · Fixed by seqan/seqan3#2367
Assignees
Labels
good first issue Good for newcomers

Comments

@smehringer
Copy link
Member

smehringer commented Nov 30, 2020

Description

Should be tackled after the new alphabet #267 is included!

The quality alphabets are not understood easily. Should I use phred42 pr phred63? What's the difference? And which "Format" (regarding the Sanger/Illumina/Solexa encoding) is used?

Our documentation is not completely clear about this and should be improved.

References:

Tasks

  • Work yourself into what the phred alphabet is representing. First by reading our documentation, s.t. you have hands-on experience which parts are confusing.
  • Improve the documentation on the quality landing page s.t. it is clearer to users what quality alphabet they should use in which case. Kind of a guide to follow.
  • Also reference (\ref) the landing page documentation on the individual quality alphabets (phred42/63/68legacy) documentation, s.t. the user is pointed to the detailed documentation
  • [EDIT (irallia)] Add a tutorial Phred score part to the alphabet tutorial. Add a snippet which represents a dna phred score combination to show the context for phred scores.
  • [EDIT (irallia)] Give also an explanation about Phred+33 and Phred+64 (we use only Phred+33?)?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants