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

docs: add apoe haplotype example #61

Merged
merged 3 commits into from
Jul 1, 2022
Merged

docs: add apoe haplotype example #61

merged 3 commits into from
Jul 1, 2022

Conversation

gymreklab
Copy link
Collaborator

Adding test VCF and haplotypes for apoe4

Example command:

haptools transform -s NA12878 tests/data/apoe.vcf.gz tests/data/apoe4.hap

Copy link
Member

@aryarm aryarm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice! thanks for trying it out and double checking that it works!

I think this would be a great addition to the examples section in the docs for the transform subcommand:

Examples
~~~~~~~~
.. code-block:: bash

	haptools transform -o output.vcf.gz -s NA12878 tests/data/apoe.vcf.gz tests/data/apoe4.hap

and then you could probably even retitle this PR as a documentation-based PR, for example:

docs: add apoe haplotype example

@gymreklab gymreklab changed the title adding apoe haplotype example docs: add apoe haplotype example Jul 1, 2022
@gymreklab
Copy link
Collaborator Author

Thanks for these suggestions! I implemented these and am merging.

@gymreklab gymreklab merged commit d35c1ec into main Jul 1, 2022
@gymreklab gymreklab deleted the test-transform branch July 1, 2022 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants