{ "info": { "author": "Eike J. Steinig", "author_email": "eikejoachim.steinig@my.jcu.edu.au", "bugtrack_url": null, "classifiers": [], "description": "## DartQC\n### Quality Control Pipeline\n\nCommand 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.\n\n#### Install\n\n`pip install dartqc`\n\n#### How to use DartQC\n\nThis 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).\n\n1. [Install DartQC](https://github.com/esteinig/dartQC/blob/master/readme/install.md)\n2. [Task: prepare](https://github.com/esteinig/dartQC/blob/master/readme/task.prepare.md)\n3. [Task: process](https://github.com/esteinig/dartQC/blob/master/readme/task.process.md)\n4. [Task: filter](https://github.com/esteinig/dartQC/blob/master/readme/task.filter.md)\n5. [DartQC on Zodiac]()\n\n#### Tasks\n\nDartQC has a hierarchical parser structure that allows you to set global options and execute a task (prepare, process, filter) with its own specific arguments:\n\n```\ndartqc --help\n\ndartqc prepare --help\ndartqc process --help\ndartqc filter -- help\n```\n\nGlobal arguments are specified before the command for a task, like this:\n\n**`dartqc`**`--project example --output_path ./example`**`prepare`**`--file example_data.csv`\n\n\n#### Quick Start\n\nExample workflow without pre-processing from Excel or CSV:\n\n```\nsource activate dartqc\n\n# CSV\ndartqc prepare --file example.csv\n# Excel\ndartqc prepare --file example.xlsx --sheet double_row_snps\n\ndartqc filter --call example.csv --call_scheme example_scheme.json --maf 0.02 --clusters\n\nsource deactivate\n```\n\nExample workflow with pre-processing:\n\n```\nsource activate dartqc\n\ndartqc prepare --file calls.csv\ndartqc prepare --file raw.csv\n\ndartqc filter -c calls.csv --call_scheme calls_scheme.json -r raw.csv --raw_scheme raw_scheme.json --read_threshold 7\n\ndartqc filter --processed ./example --maf 0.02 --call_rate 0.7 --duplicates --clusters\n\nsource deactivate\n```\n\n---\n\n
\n
\n