Skip to main content

An interactive VCF filtering tool

Project description

SNPSnip - An interactive VCF Filtering Tool

SNPSnip is a command-line tool with an interactive web interface for filtering VCF files in multiple stages.

Prerequisites

  • Python 3.8 or higher
  • bcftools must be installed and available in your PATH

Install from source

pip install git+https://github.com/gekkonid/snpsnip.git

Usage

Basic usage:

snpsnip --output-dir filtered_results --vcf input.vcf.gz --maf 0.05 --max-missing 0.1 --min-qual 30

If you need, you can change the web server settings:

snpsnip --vcf input.vcf.gz --host 0.0.0.0 --port 8080

Workflow

  1. Initial Processing: SNPSnip extracts a random subset of SNPs passing basic filters.
  2. Sample Filtering: The web UI allows you to filter samples based on quality metrics and PCA clustering.
  3. Variant Filtering: For each sample group, set filtering thresholds for various metrics.
  4. Final Processing: The tool applies your filters to the full VCF file to generate filtered outputs.

License

MPL2

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

snpsnip-0.0.3.tar.gz (25.7 kB view details)

Uploaded Source

Built Distribution

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

snpsnip-0.0.3-py3-none-any.whl (24.6 kB view details)

Uploaded Python 3

File details

Details for the file snpsnip-0.0.3.tar.gz.

File metadata

  • Download URL: snpsnip-0.0.3.tar.gz
  • Upload date:
  • Size: 25.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for snpsnip-0.0.3.tar.gz
Algorithm Hash digest
SHA256 92d567ec0bedcf71e052770316b71d174c5809e01d10360aadbf416ef33fe623
MD5 a30f43cc0a9c826e29236742f69df88e
BLAKE2b-256 9bd2c35e28327cf7c40945dafbf9db18535e0a176a4de47cb20e4c7d2a17cccb

See more details on using hashes here.

File details

Details for the file snpsnip-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: snpsnip-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 24.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for snpsnip-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 97c25e84b0d56097766c25a8f2d5370e61e8506a0cb11eb86fb47f588a6ea17a
MD5 cb7d8638f79abb08f6cd06038ddf3375
BLAKE2b-256 2976a07183680dc765718399841470bc1704e79d016e9543b1236c4b1cb6dac6

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