RFMix-reader is a Python package designed to efficiently read and process output files generated by RFMix, a popular tool for estimating local ancestry in admixed populations. The package employs a lazy loading approach, which minimizes memory consumption by reading only the loci that are accessed by the user, rather than loading the entire dataset into memory at once.
Project description
rfmix-reader
rfmix-reader
is a Python package designed to efficiently read and process output
files generated by RFMix, a popular tool for estimating local ancestry in admixed
populations. The package employs a lazy loading approach, which minimizes memory
consumption by reading only the loci that are accessed by the user, rather than
loading the entire dataset into memory at once. Additionally, we leverage GPU
acceleration to improve computational speed.
Install
rfmix-reader
can be installed using pip:
pip install rfmix-reader
GPU Acceleration:
rfmix-reader
leverages GPU acceleration for improved performance. To use this
functionality, you will need to install the following libraries for your specific
CUDA version:
RAPIDS
: Refer to official installation guide herePyTorch
: Installation instructions can be found here
Additoinal Notes:
- We have not tested installation with
Docker
orConda
environemnts. Compatibility may vary. - If you do not have GPU, you can still use the basic functionality of
rfmix-reader
.
Key Features
Lazy Loading
- Reads data on-the-fly as requested, reducing memory footprint.
- Ideal for working with large RFMix output files that may not fit entirely in memory.
Efficient Data Access
- Provides convenient access to specific loci or regions of interest.
- Allows for selective loading of data, enabling faster processing times.
Seamless Integration
- Designed to work seamlessly with existing Python data analysis workflows.
- Facilitates downstream analysis and manipulation of RFMix output data.
Whether you're working with large-scale genomic datasets or have limited computational resources, RFMix-reader offers an efficient and memory-conscious solution for reading and processing RFMix output files. Its lazy loading approach ensures optimal resource utilization, making it a valuable tool for researchers and bioinformaticians working with admixed population data.
Usage
This works similarly to pandas-plink
:
Two population admixture example
from rfmix_reader import read_rfmix
file_path = "examples/two_popuations/out/"
loci, rf_q, admix = read_rfmix(file_path)
Three population admixture example
Authors
Citation
Please cite: XXXX.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for rfmix_reader-0.1.12-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30609d952e12fa8f461d9fe15229a45846435de986326e08098e850c81d5a828 |
|
MD5 | 87eb8e631997de79535d04e70bf4dede |
|
BLAKE2b-256 | 54e5fca638a748566a0e491a5833bbdd2d7b5b9693abf1d912224fd5da3018b0 |
Hashes for rfmix_reader-0.1.12-cp39-cp39-manylinux_2_34_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 898439a46699b513ba9d5c70c638a78516991f09f88d35f5a1999bee46a3bf6c |
|
MD5 | 4d212527bbc007cf07c63e76ef9307f0 |
|
BLAKE2b-256 | 8d8e4bc433c21afd6459e74b49c2b97aa3a5c128aa13b733cf03b63cd511393d |