Skip to main content

prstools

prstools is software to create Polygenic Risk Scores (PRS) directly from the commandline.

It makes PRS generation easier, compared to previous tools, by:

  • Super fast reading and matching of sumstats (handles odd formats).
  • Rapid creation of the model.
  • Automatic generation of the PRS Prediction for target plink files.

All the above, for a real GWAS sumstat, within 30 minutes using only 1 command. Installation and running the demo example should not take more than 10 minutes.

Website: https://prstools.readthedocs.io/

Install

To install use the following command.

pip install -U --prefer-binary prstools

For it to work, you should have python3.8 or later installed (pip is included in python3.8+). If the command above does not work directly you can install using conda (or mamba if you have that) by running conda install "python>=3.9". For other install issues please check the install guide or send us a mail.

How to use

Immediately after installing prstools, it should be possible to download & run the demo example (~4mb), by pasting the following into the commandline:

# Makes 'example' dir with data in current path:
prstools downloadutil --pattern example --destdir ./; cd example

# Run the model with example data:
prstools prscs2 --ref ldref_1kg_pop --target target \
                --sst sumstats.tsv --n_gwas 2565 --out ./result 

This will run PRS-CS2 and make PRS prediction using example data. The best and fastest way to get a PRS for your case is to try the Getting Started Tutorial.

There is also the prstools reference documentation, residing inside of the command-line interface (e.g. type prst prscs2 --help), with copy-pastable examples to help illustrate usage. The same documention is also available online.

Tutorial + Video

For more information and a hands-on demonstration of what prstools can do, have a look at the Getting Started Tutorial. There is also a Video. The tutorial+video is a tiny bit older than the current prstools version, which has more functionality. You can load the tutorial in a free cloud instance by clicking here: Google Colab.

Contact

For questions and support please send a mail (menno.j.witteveen@gmail.com).

We are actively developing prstools and feedback by mail or our feedback form (with 🏆 lottery) is much appreciated!

Metadata

Release files for prstools 0.0.81

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for prstools 0.0.81
File Size Uploaded
prstools-0.0.81.tar.gz 2.0 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for prstools 0.0.81
File Interpreter ABI Platform
prstools-0.0.81-py3-none-any.whl Python 3 none any Details

Total release size: 4.0 MB

Release files / prstools-0.0.81.tar.gz

Download URL prstools-0.0.81.tar.gz
Size 2.0 MB
Tags Source
SHA-256 checksum
How to use checksums
1dc7db63a37cf71ba783199f38f757c55c1b95a5b5a11b66c13328294734f425
BLAKE2b-256 checksum
How to use checksums
09a996836ab57f64489f509094817054c4fa55235256166fac6d9aa5d4d95e25
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.4

Release files / prstools-0.0.81-py3-none-any.whl

Download URL prstools-0.0.81-py3-none-any.whl
Size 2.0 MB
Tags Python 3
SHA-256 checksum
How to use checksums
b3cca1c2ae5cf63d8ba3c78f75cd8321a52b11e28c872f76b340154c1b4154d3
BLAKE2b-256 checksum
How to use checksums
5985d71628f9872c49b2bda23be00612c66eead985b8f8fba79aecb11fb86e57
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.4
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page