Skip to main content

Preprocess, quality control and prepare consumer DTC genomes for research

Project description

GenomePrep

To preprocess, quality control and prepare consumer DTC genomes for research

Tutorial

https://genomeprep.readthedocs.io/en/latest/index.html

Installation & Usage

Install

pip install genomeprep

Download reference data

Before processing, download the required reference files:

genomeprep download-data

Files are saved to ~/.cache/genomeprep/ by default. To use a custom location:

genomeprep download-data --dest /path/to/data
# or set the environment variable:
export GENOMEPREP_DATA_DIR=/path/to/data

Note: The GRCh37 reference FASTA (~3 GB) must be supplied manually. Download Homo_sapiens.GRCh37.75.dna.toplevel.fa from ftp://ftp.ensembl.org/pub/release-75/fasta/homo_sapiens/dna/ and place it in your data directory.

Process a genome file

genomeprep process my_genome.txt -d /path/to/data -o ./outputs

Python API

from genomeprep import process
from genomeprep.data import download, get_data_dir

result = process("my_genome.txt", datadir="/path/to/data")
print(result.status)  # "Processed", "Invalid", etc.

Interactive server and bulk downloads

https://supfam.org/GenomePrep/

Incentive

The open-source GenomePrep tool-kit, developed on the goodwill of open genome data, addresses the problem of processing raw DTC DNA data in the context of the present: genotype arrays. The output of GenomePrep are DNA datafiles of homogenous formats (23andMe-like or vcf), which enable further research analysis. A single combined data-freeze of genomes that passed checks is also available in official website.

Feature

  1. Developed based on over 7,000 open genetic data
  2. Automatic processing any inputs, identify genome from zip files, automatic parsing, converting various DTC genome formats into 23andMe-like format or VCF format.
  3. Automatic recognition of chip array version
  4. Supply possibly problematic SNP position filter, stats developed from processing genetic data.

Publication

C. Lu, B. Greshake Tzovaras, J. Gough, A survey of direct-to-consumer genotype data,and quality control tool (GenomePrep) for research, Computational and Structural Biotechnology Journal(2021), doi: https://doi.org/10.1016/j.csbj.2021.06.040

Run GenomePrep locally

Download

Download datadir.tar.gz from Zenodo (https://zenodo.org/records/11408421), which contains dependencies for bin/process.py:

  • api.23andme.com
  • badalleles.dat
  • RS2GRCh37Orien_1.dat
  • THE_LIST.dat

To download all dependencies, including from public datasets

tar -xvf datadir.tar.gz
cd datadir
wget tp://ftp.ensembl.org/pub/release-75/fasta/homo_sapiens/dna/Homo_sapiens.GRCh37.75.dna.toplevel.fa.gz
gunzip Homo_sapiens.GRCh37.75.dna.toplevel.fa.gz
wget ftp://hgdownload.cse.ucsc.edu/goldenPath/hg38/liftOver/hg38ToHg19.over.chain.gz
wget http://hgdownload.soe.ucsc.edu/goldenPath/hg18/liftOver/hg18ToHg19.over.chain.gz

Run GenomePrep on a sample genotype array

bin/process.py tutorial/testgenome.zip -d ./datadir -o ./outputs -i vcfindex

We analyzed ~5000 OpenSNP genomes in 2020, the number is growing - see how many there are now here

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

genomeprep-1.2.0.tar.gz (22.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

genomeprep-1.2.0-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

Details for the file genomeprep-1.2.0.tar.gz.

File metadata

  • Download URL: genomeprep-1.2.0.tar.gz
  • Upload date:
  • Size: 22.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for genomeprep-1.2.0.tar.gz
Algorithm Hash digest
SHA256 74b676da87087994ded24544472d06a2f567ef6ca60e5d2277f6c436b66423a4
MD5 166d910acee4fd7539867ed1cd95e40f
BLAKE2b-256 b4c7c5e396208986878d1a240c043cc7b5a3d33c8f3fd48d8b8df1182af4cda7

See more details on using hashes here.

File details

Details for the file genomeprep-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: genomeprep-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 16.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for genomeprep-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e070b9852d735c62e0090259f71c9f0545dcdba2ce69acdfff01e3558775108a
MD5 95943c8621acfd4007270e8b1617a788
BLAKE2b-256 f1ef6babdbe9441e5d8c959fa85c6d66facdd04dcb511ada9341995cd675eec5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page