+ document how to run bcftools commands from pysam #1275
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- this wasn't explicitly stated in the documentation. I was
using the notes described in [github issue 958][0] as a guide.
- in the changes also put updated links to the bcftools and htslib.org pages
[0]: pysam-developers#958
jmarshall
added a commit
that referenced
this pull request
Jan 21, 2025
…tation Describe both samtools and bcftools invocations. Supersedes #1275. Add reference documentation covering all the keyword arguments, etc. Describe in detail how to redirect output to a file, a common use case. Fixes #1096, fixes #1241, fixes #1323, et al. Update doc/conf.py's rst_epilog samtools and bcftools URLs to point to version-specific man pages, and have devtools/import.py update the URLs.
|
Thanks for the suggestion to document the bcftools subcommands too. I've taken an alternative approach in 51ff3f1 and incorporated bcftools into the existing samtools documentation. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I recently had trouble running the
bcftoolscommands within pysam. I saw the "Using samtools commands within python" section within the documentation and thought things would behave similarly. I didn't find it to be true. I ended up finding the solution through github issue 958.I thought it would be nice to have this
bcftoolsfeature more explicitly documented for future users.Let me know if any additional changes are desired.