https://github.com/openmendel/pgenfiles.jl

https://github.com/openmendel/pgenfiles.jl

Last synced: over 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/openmendel/pgenfiles.jl
• Owner: OpenMendel
• License: mit
• Created: 2021-11-08T20:12:47.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-23T02:14:25.000Z (about 2 years ago)
• Last Synced: 2024-04-23T10:54:46.137Z (about 2 years ago)
• Language: Julia
• Size: 1.43 MB
• Stars: 3
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# PGENFiles.jl

[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://OpenMendel.github.io/PGENFiles.jl/dev)

[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://OpenMendel.github.io/PGENFiles.jl/stable)

[![codecov](https://codecov.io/gh/OpenMendel/PGENFiles.jl/branch/main/graph/badge.svg?token=W28QPREGC7)](https://codecov.io/gh/OpenMendel/PGENFiles.jl)

[![build Actions Status](https://github.com/OpenMendel/PGENFiles.jl/workflows/CI/badge.svg)](https://github.com/OpenMendel/PGENFiles.jl/actions)

Routines for reading compressed storage of genotyped or imputed markers

[*Genome-wide association studies (GWAS)*](https://en.wikipedia.org/wiki/Genome-wide_association_study) data with imputed markers are often saved in the [**PGEN format**](https://www.cog-genomics.org/plink/2.0/input#pgen) in `.pgen` file.

It can store both hard calls and imputed data, unphased genotypes and phased haplotypes. Each variant is compressed separately. This is the central data format for [PLINK 2](https://www.cog-genomics.org/plink/2.0/). 

## Installation

This package requires Julia v1.6 or later, which can be obtained from

https://julialang.org/downloads/ or by building Julia from the sources in the

https://github.com/JuliaLang/julia repository.

This package is registered in the default Julia package registry, and can be installed through standard package installation procedure: e.g., running the following code in Julia REPL.

```julia

using Pkg

pkg"add PGENFiles"

```

## Citation

If you use [OpenMendel](https://openmendel.github.io) analysis packages in your research, please cite the following reference in the resulting publications:

*Zhou H, Sinsheimer JS, Bates DM, Chu BB, German CA, Ji SS, Keys KL, Kim J, Ko S, Mosher GD, Papp JC, Sobel EM, Zhai J, Zhou JJ, Lange K. OPENMENDEL: a cooperative programming project for statistical genetics. Hum Genet. 2020 Jan;139(1):61-71. doi: 10.1007/s00439-019-02001-z. Epub 2019 Mar 26. PMID: 30915546; PMCID: [PMC6763373](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6763373/).*

## Acknowledgments

This project has been supported by the National Institutes of Health under awards R01GM053275, R01HG006139, R25GM103774, and 1R25HG011845.