Skip to main content

Automate IMGT V-QUEST usage on imgt.org

Project description

Automate IMGT V-QUEST usage on imgt.org

vquest

IMGT's V-QUEST is only available via a web interface. This Python package automates V-QUEST usage by submitting request data like the web form does. Currently only the "Download AIRR formatted results" option is supported.

Example command-line usage, with rhesus sequences in seqs.fasta:

pip install . # or skip this and use "python -m vquest" below
vquest --species rhesus-monkey --receptorOrLocusType IG --fileSequences seqs.fasta

The output is saved to Parameters.txt and vquest_airr.tsv (the files V-QUEST provides in a zip archive) in the working directory by default.

Or with --align to automatically extract the alignment as FASTA:

vquest --align --species rhesus-monkey --receptorOrLocusType IG --fileSequences seqs.fasta

Here the aligned FASTA text is printed directly to standard output.

Example Python usage:

>>> from vquest.vq import *
>>> config = layer_configs(DEFAULTS, {"species": "rhesus-monkey", "receptorOrLocusType": "IG", "fileSequences": "seqs.fasta"})
>>> result = vquest(config)
>>> result.keys()
dict_keys(['Parameters.txt', 'vquest_airr.tsv'])

Here the output is a dictionary of filenames to contents.

The only required options are species, receptorOrLocusType, and either fileSequences or sequences (to provide sequences directly as text). Options can be given via command-line arguments or one or more YAML configuration files. See data/defaults.yml and ./vquest.py --help for details.

The web form will only accept 50 sequences at a time, so the sequences given here are grouped into chunks of 50, submitted, and (by default) the results automatically combined. A delay (default 1 second) is used between submissions to avoid being impolite to the server.

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

vquest-0.0.10.tar.gz (27.3 kB view details)

Uploaded Source

Built Distribution

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

vquest-0.0.10-py3-none-any.whl (29.5 kB view details)

Uploaded Python 3

File details

Details for the file vquest-0.0.10.tar.gz.

File metadata

  • Download URL: vquest-0.0.10.tar.gz
  • Upload date:
  • Size: 27.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.0 importlib_metadata/3.7.3 packaging/20.9 pkginfo/1.7.0 requests/2.25.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.5

File hashes

Hashes for vquest-0.0.10.tar.gz
Algorithm Hash digest
SHA256 587ca6c88afa8a0f16613200a36f17d66ec6a7088f5ac6770a7396890ceb679e
MD5 3a0244aa5a03f6fe726b797f89e5fba4
BLAKE2b-256 88058af055ae140a9131dc50af6a8f608ad124dac15b5c7a7c0bc44de20d21b9

See more details on using hashes here.

File details

Details for the file vquest-0.0.10-py3-none-any.whl.

File metadata

  • Download URL: vquest-0.0.10-py3-none-any.whl
  • Upload date:
  • Size: 29.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.0 importlib_metadata/3.7.3 packaging/20.9 pkginfo/1.7.0 requests/2.25.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.5

File hashes

Hashes for vquest-0.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 070dbd7b118f355b0aad02e2e217b5a86f477562ecab42bf7add379da1801d56
MD5 e39a90449b01843c396d50d6e4c966bc
BLAKE2b-256 db02e6171c46ce6c8039ec1393656fb7a5e96be157da7ccf8544e80d19e35908

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