Skip to main content

Convert SNP array to VCF

Project description

Array As VCF

array-as-vcf is a small library and tool to convert common SNP array formats to VCF format.

There are four currently supported array formats:

  • Affymetrix (TSV export)
  • Cytoscan HD Array (TSV export)
  • Lumi 317k array (TSV export)
  • Lumi 370k array (TSV export)
  • Multi-sample OpenArray (TSV export)

Binary formats are not (yet) supported.

Requirements

  • Python 3.6
  • requests

CLI usage

The array-as-vcf tool will convert array files to VCF format. It will auto-detect the type of array file, and throw an error if it can't determine it.

The generated VCF file is printed to stdout.

A sample name to be used in the VCF file must be supplied.

The REF and ALT alleles will be queried from Ensembl if no lookup-table is supplied. This requires a working internet connection, and can be quite slow due the amount of HTTP requests that are necessary.

When supplied with lookup-table, no requests are made for the rsIDs which exist within the lookup table. The lookup table is a JSON file, containing a single large object of shape:

{
  "rs0": "{ref_allele}:{alt_alleles}:{ref_is_minor_allele}"
}

E.g.

{
  "rs1000003": "A:G:F"
}

If you have never run array-as-vcf before , you can run array-as-vcf sans lookup table and dump the generated internal lookup table to a file for next iterations.

Usage: array-as-vcf [OPTIONS]

Options:
  -p, --path PATH              Path to array file  [required]
  -b, --build [GRCh37|GRCh38]
  -s, --sample-name TEXT       Name of sample in VCF file
  -c, --chr-prefix TEXT        Optional prefix to chromosome names
  -l, --lookup-table PATH      Optional path to existing lookup table for
                               rsIDs.
  -d, --dump PATH              Optional path to write generated lookup table
  --help                       Show this message and exit.

Project details


Release history Release notifications

This version

1.0.0

Download files

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

Files for array-as-vcf, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size array_as_vcf-1.0.0-py3-none-any.whl (13.3 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size array-as-vcf-1.0.0.tar.gz (12.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page