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.4.tar.gz (32.2 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.4-py3-none-any.whl (31.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: snpsnip-0.0.4.tar.gz
  • Upload date:
  • Size: 32.2 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.4.tar.gz
Algorithm Hash digest
SHA256 5fbb42d1cd79cd1ef035992d918c42196341e0f0ebdefa02366425b08482819f
MD5 3a5514ed83935492450190bfbbc410f1
BLAKE2b-256 802c2e20265a9462e3d3cc29a4dfec6d9c241bf542580ba5f273ef13787251b8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: snpsnip-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 31.2 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5ab4dad155a9907a9c479bff0212ce4306ff45328e8adbb71ba1da3fd2b3f506
MD5 c35ce5074edd991b3a2ed373b6902c84
BLAKE2b-256 c7121b8c1c4aa6d976a098e628b218166a1ad0292b14e05f1d4b61891c6302b6

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