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.
Metadata
Release files for array-as-vcf 1.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| array-as-vcf-1.1.0.tar.gz | 12.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| array_as_vcf-1.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 25.4 kB
Release files / array-as-vcf-1.1.0.tar.gz
| Download URL | array-as-vcf-1.1.0.tar.gz |
|---|---|
| Size | 12.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6f8c88b8c6f7ca4e6dec7625cafba97b0616190ffbc09952ab61aa40f95a099b
|
|
BLAKE2b-256 checksum How to use checksums |
cbc10d27fa9c2bc6ab2cd87e3ada18a60c9a7d045f64620da5410a45e3604700
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.5
|
Release files / array_as_vcf-1.1.0-py3-none-any.whl
| Download URL | array_as_vcf-1.1.0-py3-none-any.whl |
|---|---|
| Size | 13.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7979f84ad23a86567263d90ba3a6ec97ae3145cdac1fd4857d177016a2812b19
|
|
BLAKE2b-256 checksum How to use checksums |
3d91d0297acf04df4231b00178e5df889d60e7d999c2d861591e967447c2a177
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.5
|