Welcome to rfmix-reader’s documentation!

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.

Table of Contents

• Install
  • GPU Acceleration
• Haplotypes
  • Input
  • Output
• Loci Imputation
• API
  • Main functions
  • Support functions
  • Admixture functions

Citation

If using, please cite the following pre-print:

Kynon JM Benjamin. “RFMix-reader: Accelerated reading and processing for local ancestry studies.” bioRxiv. 2024. DOI: 10.1101/2024.07.13.603370

Comments and bugs

You can get the source code and open issues on Github.

Indices and tables

• Index

• Search Page