Skip to main content

Quality control for SNP data from Diversity Array Technologies (DArT)

Project description

## DartQC
### Quality Control Pipeline

Command line pipeline to facilitate quality control of SNP data from Diversity Array Technologies (DArT). This version is a re-write of the original scripts aiming to be somewhat more user-friendly and executable on JCU's HPC.

#### Install

`pip install dartqc`

#### How to use DartQC

This section provides a brief guide of how to install and use the pipeline components. This assumes you are using a Bash shell on a local Unix system or the JCU's HPC (Zodiac).

1. [Install DartQC](https://github.com/esteinig/dartQC/blob/master/readme/install.md)
2. [Task: prepare](https://github.com/esteinig/dartQC/blob/master/readme/task.prepare.md)
3. [Task: process](https://github.com/esteinig/dartQC/blob/master/readme/task.process.md)
4. [Task: filter](https://github.com/esteinig/dartQC/blob/master/readme/task.filter.md)
5. [DartQC on Zodiac]()

#### Tasks

DartQC has a hierarchical parser structure that allows you to set global options and execute a task (prepare, process, filter) with its own specific arguments:

```
dartqc --help

dartqc prepare --help
dartqc process --help
dartqc filter -- help
```

Global arguments are specified before the command for a task, like this:

**`dartqc`**`--project example --output_path ./example`**`prepare`**`--file example_data.csv`


#### Quick Start

Example workflow without pre-processing from Excel or CSV:

```
source activate dartqc

# CSV
dartqc prepare --file example.csv
# Excel
dartqc prepare --file example.xlsx --sheet double_row_snps

dartqc filter --call example.csv --call_scheme example_scheme.json --maf 0.02 --clusters

source deactivate
```

Example workflow with pre-processing:

```
source activate dartqc

dartqc prepare --file calls.csv
dartqc prepare --file raw.csv

dartqc filter -c calls.csv --call_scheme calls_scheme.json -r raw.csv --raw_scheme raw_scheme.json --read_threshold 7

dartqc filter --processed ./example --maf 0.02 --call_rate 0.7 --duplicates --clusters

source deactivate
```

---

<p align="center">
<img src="https://github.com/esteinig/dartQC/blob/master/workflow.png" height="768" width="768">
</p>

---

### Contact

If you find any bugs, please submit an issue for this repository on GitHub.



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

dartqc-0.1.5.tar.gz (25.0 kB view hashes)

Uploaded Source

Supported by

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