Skip to main content

Taboo provides an automated pipipeline for comparinggenotypes from different assays.

Project description

<p align="center">
<a href="https://github.com/Clinical-Genomics/taboo">
<img width="240px" height="180px" src="artwork/icon.png"/>
</a>
</p>

# Taboo [![Documentation Status][readthedocs-img]][readthedocs-url] [![Build Status][travis-img]][travis-url]
Manage SNP calling comparisons at Clinical Genomics. The package exposes a CLI and a bare bones web interface to visualize results stored in a SQLite database.

## Install

```bash
$ git clone https://github.com/Clinical-Genomics/taboo && cd taboo
$ pip install --editable .
```

## CLI interface
For automation you interact with Taboo using either the command line interface or the Python API. I will focus on documenting the CLI for now.

### Base command: `taboo`
Some options work across all subcommands in Taboo. Especially important is the "config" command. By pointing to a config, you will be able to set important defaults that will enable Taboo to automate a lot of tedious boilerplate for you. Here is an [example config file](https://github.com/Clinical-Genomics/taboo/blob/master/tests/config/test.yaml).

- `--config`: load a Taboo config file (YAML)

```bash
$ taboo --config /path/to/config.yaml [subcommand]
```

### Initial setup: `init`
This request will setup a new database with empty tables.

- `--reset`: will reset an existing database

```bash
$ taboo init
```

### Load results: `load`
This command lets you load results from sequencing (`.vcf`) and MAF genotyping (`.xlsx`). It works on a per analysis/sample level which means that you can restart an upload and only the missing samples will be added the second time.

- `--include-key`: string to look for in sample id to determine which rows to include (Excel)
- `--force`: overwrite existing analyses

```bash
$ taboo load [INPUT_FILE]
```

### Compare results: `match`
Compare genotypes for an analysis across all alternative analyses. The result of the comparison is stored in the database.

### Show details: `show`
You can view detailed information about samples and analyses to manually inspect what the comparisons are based on. This can be useful if you detect some unexpected results.

### Start web server: `view`
Bring up a web server to visualize the database with samples in a web browser. From there you can upload results from genotyping and execute the comparison per sample. You will be able to see the status per sample as well as look at the sex determinations and whether they support the same conclusion.


## License
MIT. See the [LICENSE](LICENSE) file for more details.



[readthedocs-url]: https://readthedocs.org/projects/taboo/?badge=latest
[readthedocs-img]: https://readthedocs.org/projects/taboo/badge/?version=latest

[travis-url]: https://travis-ci.org/Clinical-Genomics/taboo
[travis-img]: https://img.shields.io/travis/Clinical-Genomics/taboo.svg?style=flat

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

taboo-0.7.4.tar.gz (3.6 MB view details)

Uploaded Source

Built Distribution

taboo-0.7.4-py2.py3-none-any.whl (29.9 kB view details)

Uploaded Python 2Python 3

File details

Details for the file taboo-0.7.4.tar.gz.

File metadata

  • Download URL: taboo-0.7.4.tar.gz
  • Upload date:
  • Size: 3.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for taboo-0.7.4.tar.gz
Algorithm Hash digest
SHA256 c62e0094fa3c9f60e7c7ffac5acacfc31fd1c7d8cbe460990c73a6305770a32c
MD5 e497ca5bf1b9c74cdeeb4089c8356e89
BLAKE2b-256 e51ae4565d46bdd63f786b9d76cfacbbcbb9dd9031b9f2bda59379be601714c5

See more details on using hashes here.

File details

Details for the file taboo-0.7.4-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for taboo-0.7.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0def17f91aeffbabeada9ed8d1e291569dc466d70962567d38f88ad1a9bdaa2a
MD5 1e02edbc559ef270407b401cd43806b2
BLAKE2b-256 248900413af442eff181a4a1b2eaae432a977d0ec7e865a28d6880c28c422842

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page