Skip to main content

GUI to visualize and process variant data

Project description

Cutevariant

A standalone and free application to explore genetics variations from VCF file

A preprint is available in bioRxiv Documentation available on cutevariant.labsquare.org

Test

Cutevariant is a cross-plateform application dedicated to maniupulate and filter variation from annotated VCF file. When you create a project, data are imported into an sqlite database that cutevariant queries according your needs. Presently, SnpEff and VEP annotations are supported. Once your project is created, you can query variant using different gui controller or directly using the VQL language. This Domain Specific Language is specially designed for cutevariant and try to keep the same syntax than SQL for an easy use.

screen shot 2017-08-07 at 12 18 15 pm screen shot 2017-08-07 at 12 18 15 pm screen shot 2017-08-07 at 12 18 15 pm

Installation

Windows

Standalone binary are available for windows:

PyPi

Cutevariant is avaible from Pypi :

pip install cutevariant # install
python -m cutevariant   # run

From source

  • Python 3.7 or newer is required
# Clone repository
git clone https://github.com/labsquare/cutevariant.git
cd cutevariant
# Create a virtual environement
python3 -m virtualenv venv 
source venv/bin/activate
# Install cutevariant in local mode
python -m pip install -e 
# Run cutevariant as module 
python -m cutevariant # or `make run`
# Run test 
python -m pytest tests

Usages

You can follow this tutorial to familiarize yourself with cutevarant.
https://github.com/labsquare/cutevariant/wiki/Usage-examples

The VQL langage specification is available here :
https://github.com/labsquare/cutevariant/wiki/VQL-language

Contributions / Bugs

Cutevariant is a new project and all contributors are welcome

Issues

If you found a bug or have a feature request, you can report it from the Github isse trackers.

Create a plugin

Documentation to create a plugin is available here

Chat

You can join us on discord. We are speaking french right now, but we can switch to english.

Licenses

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/gpl-3.0.txt.

Project details


Download files

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

Files for cutevariant, version 0.3.8
Filename, size File type Python version Upload date Hashes
Filename, size cutevariant-0.3.8-py3-none-any.whl (835.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size cutevariant-0.3.8.tar.gz (791.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page