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

Clarify terminology with respect to unpaired/SE reads #47

Closed
bede opened this issue Nov 13, 2024 · 2 comments
Closed

Clarify terminology with respect to unpaired/SE reads #47

bede opened this issue Nov 13, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@bede
Copy link
Owner

bede commented Nov 13, 2024

References to unpaired reads in the CLI help and README are potentially ambiguous, possibly interpreted as reads lacking a mate for QC reasons or otherwise. It is intended to refer to single end (SE) short reads, for instance Illumina reads that have been merged. This should be reviewed and clarified. Highlighted by @jfy133 (#46).

@bede bede added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 13, 2024
@bede bede added this to the 1.2.0 milestone Nov 13, 2024
bede added a commit that referenced this issue Nov 15, 2024
@bede
Copy link
Owner Author

bede commented Nov 15, 2024

In 9634e7a I've replaced references to "unpaired" reads with "single/unpaired". I've also clarified the behaviour of the default --aligner auto in the CLI help.

@bede bede closed this as completed Nov 21, 2024
@jfy133
Copy link

jfy133 commented Nov 25, 2024

I think that would help future me yes, thank you @bede !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants