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.

Sign up for GitHub

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

Update README to refer to pyigd #23

Merged
merged 1 commit into from
Dec 23, 2024
Merged

Update README to refer to pyigd #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Features:

More details can be found in the supplement of our [preprint "Genotype Representation Graph" paper](https://www.biorxiv.org/content/10.1101/2024.04.23.590800v1).

See also [pyigd](https://github.com/aprilweilab/pyigd/) if you want Python access to IGD files.

## Using the library

Either copy the latest header file (`picovcf.hpp`) into your project directly, or make use of something like git submodules to include https://github.com/aprilweilab/picovcf.
Expand Down Expand Up @@ -87,4 +89,4 @@ Converting the `.vcf.gz` to `.bgen` (via qctool) took 23 minutes, but converting
* Use `igdtools` to convert and process files
* Do one of the following:
* If your project is C++, copy [picovcf.hpp](https://github.com/aprilweilab/picovcf/blob/main/picovcf.hpp) into your project, `#include` it somewhere and then use according to the [documentation](https://picovcf.readthedocs.io/en/latest/)
* If your project is Python, clone [pyigd](https://github.com/aprilweilab/pyigd/) and install it per the [README instructions](https://github.com/aprilweilab/pyigd/blob/main/README.md).
* If your project is Python, you can install [pyigd](https://github.com/aprilweilab/pyigd/) via `pip install pyigd` (see [the docs](https://pyigd.readthedocs.io/en/latest/))
Loading