Commit 73261678 authored by adrien's avatar adrien
Browse files

Create gh-pages branch via GitHub

parent 8cb87cd0
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<link href='https://fonts.googleapis.com/css?family=Architects+Daughter' rel='stylesheet' type='text/css'>
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/pygment_trac.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print">
<meta name="description" content="Quade : Demultiplexer for PAIRED fastq files based on index sequence and PHRED quality">
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link rel="stylesheet" type="text/css" media="screen" href="stylesheets/stylesheet.css">
<title>Quade by a-slide</title>
<title>Quade</title>
</head>
<body>
<header>
<div class="inner">
<h1>Quade</h1>
<h2>Demultiplexer for PAIRED fastq files based on index sequence and PHRED quality</h2>
<a href="https://github.com/a-slide/Quade" class="button"><small>View project on</small> GitHub</a>
</div>
</header>
<div id="content-wrapper">
<div class="inner clearfix">
<section id="main-content">
<h1>
<!-- HEADER -->
<div id="header_wrap" class="outer">
<header class="inner">
<a id="forkme_banner" href="https://github.com/a-slide/Quade">View on GitHub</a>
<h1 id="project_title">Quade</h1>
<h2 id="project_tagline">Demultiplexer for PAIRED fastq files based on index sequence and PHRED quality</h2>
<section id="downloads">
<a class="zip_download_link" href="https://github.com/a-slide/Quade/zipball/master">Download this project as a .zip file</a>
<a class="tar_download_link" href="https://github.com/a-slide/Quade/tarball/master">Download this project as a tar.gz file</a>
</section>
</header>
</div>
<!-- MAIN CONTENT -->
<div id="main_content_wrap" class="outer">
<section id="main_content" class="inner">
<h1>
<a id="quade" class="anchor" href="#quade" aria-hidden="true"><span class="octicon octicon-link"></span></a>Quade</h1>
<p><strong>Fastq file demultiplexer, handling double indexing, molecular indexing and filtering based on index quality</strong></p>
<p><strong>Creation : 2015/01/07</strong></p>
<p><strong>Last update : 2015/02/06</strong> </p>
<p><strong>Last update : 2015/03/30</strong> </p>
<h2>
<a id="motivation" class="anchor" href="#motivation" aria-hidden="true"><span class="octicon octicon-link"></span></a>Motivation</h2>
......@@ -88,24 +91,32 @@ The following dependencies are required for proper program execution:</p>
<ul>
<li><p>Clone the repository or download the archive <code>git clone https://github.com/a-slide/Quade.git</code></p></li>
<li><p>Enter the src folder of the program folder and make the main script executable <code>sudo chmod u+x Quade.py</code></p></li>
<li><p>Alternatively, you can compile Quade as a C executable with cython by using the makefile <code>make</code>. Be sure that you have cython installed and added to your PATH</p></li>
<li><p>Finally, Add Quade.py (or Quade if you choose the cython alternative) in your PATH</p></li>
<li><p>Finally, Add Quade.py to your PATH</p></li>
</ul>
<h2>
<a id="usage" class="anchor" href="#usage" aria-hidden="true"><span class="octicon octicon-link"></span></a>Usage</h2>
<p>In the folder where fastq files will be output</p>
<p>In the folder where fastq files will be created</p>
<pre><code>Usage: Quade -c Conf.txt
<pre><code>Usage: Quade.py -c Conf.txt [-i -h]
Options:
--version show program's version number and exit
-h, --help show this help message and exit
-c CONF_FILE Path to the configuration file
-c CONF_FILE Path to the configuration file [Mandatory]
-i Generate an example configuration file and exit [Facultative]
</code></pre>
<p>An example configuration file is provided with the program, with detailed information for each sections</p>
<p>An example configuration file can be generated by running the program with the option -i
The configuration of options is described directly in the configuration file.
The program can be tested from the test folder with the dataset provided and the default configuration file.</p>
<pre><code>cd ./test/result
Quade.py -i
Quade.py -c Conf_file.txt
</code></pre>
<h2>
<a id="additional-information" class="anchor" href="#additional-information" aria-hidden="true"><span class="octicon octicon-link"></span></a>Additional information</h2>
......@@ -124,25 +135,18 @@ Options:
<li><a href="https://github.com/a-slide">Github</a></li>
<li><a href="http://www.atlantic-gene-therapies.fr/">Atlantic Gene Therapies - INSERM 1089</a></li>
</ul>
</section>
<aside id="sidebar">
<a href="https://github.com/a-slide/Quade/zipball/master" class="button">
<small>Download</small>
.zip file
</a>
<a href="https://github.com/a-slide/Quade/tarball/master" class="button">
<small>Download</small>
.tar.gz file
</a>
<p class="repo-owner"><a href="https://github.com/a-slide/Quade"></a> is maintained by <a href="https://github.com/a-slide">a-slide</a>.</p>
<p>This page was generated by <a href="https://pages.github.com">GitHub Pages</a> using the Architect theme by <a href="https://twitter.com/jasonlong">Jason Long</a>.</p>
</aside>
</div>
</section>
</div>
<!-- FOOTER -->
<div id="footer_wrap" class="outer">
<footer class="inner">
<p class="copyright">Quade maintained by <a href="https://github.com/a-slide">a-slide</a></p>
<p>Published with <a href="https://pages.github.com">GitHub Pages</a></p>
</footer>
</div>
</body>
</html>
{"name":"Quade","tagline":"Demultiplexer for PAIRED fastq files based on index sequence and PHRED quality","body":"# Quade\r\n\r\n**Fastq file demultiplexer, handling double indexing, molecular indexing and filtering based on index quality**\r\n\r\n**Creation : 2015/01/07**\r\n\r\n**Last update : 2015/02/06** \r\n\r\n## Motivation\r\n\r\nQuade is a **python2.7** object oriented script developed to demultiplex sample from mixed fastq files.\r\n\r\nSpecific features:\r\n\r\n* The program parse chunks of non demultiplexed raw paired end fastq files (converted in fastq by CASAVA but not demultiplexed, see [convert-bcl-to-fastq](https://gist.github.com/brantfaircloth/3125885))\r\n* Reads are attributed to a specific sample defined by index sequences. Simple and double indexing are supported.\r\n* Reads can be filtered to exclude index read with bad quality base (to avoid sample cross contamination due to errors in index read)\r\n* The program handle stochastic molecular index. Sample index and molecular index are appended at the end of sequence name for further use.\r\n\r\n![Double index](https://raw.githubusercontent.com/a-slide/Quade/master/doc/img/modified_illumina_adapters.png)\r\n\r\n## Principle\r\n\r\n1. A configuration file containing all program parameters (including sample/index association) is parsed and thoroughly verified for validity\r\n2. Non demultiplexed fastq files are read chunks by chunks, with reads from sample read1, sample read2, index read1 [and index read2] in different files.\r\n3. sample barcode and molecular index sequence are extracted from index read. In the case of double indexing sample barcode is the result of the fusion between sample barcode from index1 and index2. The same applies for molecular index \r\n4. Depending of the index (or fused index) sequence, sample reads1 and read2 are attributed to a defined sample, or to the undetermined category if appropriate.\r\n5. The phred quality of the index read is checked so as every positions is above a defined minimal value. If so reads are written in a sample **pass** file, else reads are written in a sample **fail** file.\r\n6. reads names are written as follow : *@Name_in_original_fastq:SAMPLE_BARCODE[:MOLECULAR_BARCODE]*\r\n7. a distribution report is generated\r\n\r\n![Quade](https://raw.githubusercontent.com/a-slide/Quade/master/doc/img/quade-io.png)\r\n\r\n## Dependencies\r\n\r\nThe program was developed under Linux Mint 17 and require a python 2.7 environment.\r\nThe following dependencies are required for proper program execution:\r\n\r\n* python package [numpy](http://www.numpy.org/) 1.7.1+\r\n* python package [HTSeq](http://www-huber.embl.de/users/anders/HTSeq/doc/index.html#) 0.6.1p1+\r\n\r\nIf you have pip already installed, enter the following line to install packages: ```sudo pip install numpy HTSeq```\r\n\r\n## Get and install Quade\r\n\r\n* Clone the repository or download the archive ```git clone https://github.com/a-slide/Quade.git```\r\n\r\n* Enter the src folder of the program folder and make the main script executable ```sudo chmod u+x Quade.py```\r\n\r\n* Alternatively, you can compile Quade as a C executable with cython by using the makefile ```make```. Be sure that you have cython installed and added to your PATH\r\n\r\n* Finally, Add Quade.py (or Quade if you choose the cython alternative) in your PATH\r\n\r\n## Usage\r\n\r\nIn the folder where fastq files will be output\r\n \r\n Usage: Quade -c Conf.txt\r\n \r\n Options:\r\n --version show program's version number and exit\r\n -h, --help show this help message and exit\r\n -c CONF_FILE Path to the configuration file\r\n \r\nAn example configuration file is provided with the program, with detailed information for each sections\r\n\r\n## Additional information\r\n\r\nSee Blog post [Starting a new NGS project with python : Example with a fastq demultiplexer](http://a-slide.github.io/blog/fastq_demultiplexer)\r\n\r\n## Authors and Contact\r\n\r\nAdrien Leger - 2014\r\n\r\n* <adrien.leger@gmail.com> - <adrien.leger@inserm.fr> - <adrien.leger@univ-nantes.fr>\r\n* [Github](https://github.com/a-slide)\r\n* [Atlantic Gene Therapies - INSERM 1089](http://www.atlantic-gene-therapies.fr/)","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
\ No newline at end of file
{"name":"Quade","tagline":"Demultiplexer for PAIRED fastq files based on index sequence and PHRED quality","body":"# Quade\r\n\r\n**Fastq file demultiplexer, handling double indexing, molecular indexing and filtering based on index quality**\r\n\r\n**Creation : 2015/01/07**\r\n\r\n**Last update : 2015/03/30** \r\n\r\n## Motivation\r\n\r\nQuade is a **python2.7** object oriented script developed to demultiplex sample from mixed fastq files.\r\n\r\nSpecific features:\r\n\r\n* The program parse chunks of non demultiplexed raw paired end fastq files (converted in fastq by CASAVA but not demultiplexed, see [convert-bcl-to-fastq](https://gist.github.com/brantfaircloth/3125885))\r\n* Reads are attributed to a specific sample defined by index sequences. Simple and double indexing are supported.\r\n* Reads can be filtered to exclude index read with bad quality base (to avoid sample cross contamination due to errors in index read)\r\n* The program handle stochastic molecular index. Sample index and molecular index are appended at the end of sequence name for further use.\r\n\r\n![Double index](https://raw.githubusercontent.com/a-slide/Quade/master/doc/img/modified_illumina_adapters.png)\r\n\r\n## Principle\r\n\r\n1. A configuration file containing all program parameters (including sample/index association) is parsed and thoroughly verified for validity\r\n2. Non demultiplexed fastq files are read chunks by chunks, with reads from sample read1, sample read2, index read1 [and index read2] in different files.\r\n3. sample barcode and molecular index sequence are extracted from index read. In the case of double indexing sample barcode is the result of the fusion between sample barcode from index1 and index2. The same applies for molecular index \r\n4. Depending of the index (or fused index) sequence, sample reads1 and read2 are attributed to a defined sample, or to the undetermined category if appropriate.\r\n5. The phred quality of the index read is checked so as every positions is above a defined minimal value. If so reads are written in a sample **pass** file, else reads are written in a sample **fail** file.\r\n6. reads names are written as follow : *@Name_in_original_fastq:SAMPLE_BARCODE[:MOLECULAR_BARCODE]*\r\n7. a distribution report is generated\r\n\r\n![Quade](https://raw.githubusercontent.com/a-slide/Quade/master/doc/img/quade-io.png)\r\n\r\n## Dependencies\r\n\r\nThe program was developed under Linux Mint 17 and require a python 2.7 environment.\r\nThe following dependencies are required for proper program execution:\r\n\r\n* python package [numpy](http://www.numpy.org/) 1.7.1+\r\n* python package [HTSeq](http://www-huber.embl.de/users/anders/HTSeq/doc/index.html#) 0.6.1p1+\r\n\r\nIf you have pip already installed, enter the following line to install packages: ```sudo pip install numpy HTSeq```\r\n\r\n## Get and install Quade\r\n\r\n* Clone the repository or download the archive ```git clone https://github.com/a-slide/Quade.git```\r\n\r\n* Enter the src folder of the program folder and make the main script executable ```sudo chmod u+x Quade.py```\r\n\r\n* Finally, Add Quade.py to your PATH\r\n\r\n## Usage\r\n\r\nIn the folder where fastq files will be created\r\n \r\n Usage: Quade.py -c Conf.txt [-i -h]\r\n \r\n Options:\r\n --version show program's version number and exit\r\n -h, --help show this help message and exit\r\n -c CONF_FILE Path to the configuration file [Mandatory]\r\n -i Generate an example configuration file and exit [Facultative]\r\n \r\nAn example configuration file can be generated by running the program with the option -i\r\nThe configuration of options is described directly in the configuration file.\r\nThe program can be tested from the test folder with the dataset provided and the default configuration file.\r\n```\r\ncd ./test/result\r\nQuade.py -i\r\nQuade.py -c Conf_file.txt\r\n\r\n```\r\n\r\n## Additional information\r\n\r\nSee Blog post [Starting a new NGS project with python : Example with a fastq demultiplexer](http://a-slide.github.io/blog/fastq_demultiplexer)\r\n\r\n## Authors and Contact\r\n\r\nAdrien Leger - 2014\r\n\r\n* <adrien.leger@gmail.com> - <adrien.leger@inserm.fr> - <adrien.leger@univ-nantes.fr>\r\n* [Github](https://github.com/a-slide)\r\n* [Atlantic Gene Therapies - INSERM 1089](http://www.atlantic-gene-therapies.fr/)\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
\ No newline at end of file
.highlight { background: #ffffff; }
.highlight .c { color: #999988; font-style: italic } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { font-weight: bold } /* Keyword */
.highlight .o { font-weight: bold } /* Operator */
.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */
.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */
.highlight .hll { background-color: #ffffcc }
.highlight { background: #f0f3f3; }
.highlight .c { color: #0099FF; font-style: italic } /* Comment */
.highlight .err { color: #AA0000; background-color: #FFAAAA } /* Error */
.highlight .k { color: #006699; font-weight: bold } /* Keyword */
.highlight .o { color: #555555 } /* Operator */
.highlight .cm { color: #0099FF; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #009999 } /* Comment.Preproc */
.highlight .c1 { color: #0099FF; font-style: italic } /* Comment.Single */
.highlight .cs { color: #0099FF; font-weight: bold; font-style: italic } /* Comment.Special */
.highlight .gd { background-color: #FFCCCC; border: 1px solid #CC0000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #999999 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #003300; font-weight: bold } /* Generic.Heading */
.highlight .gi { background-color: #CCFFCC; border: 1px solid #00CC00 } /* Generic.Inserted */
.highlight .go { color: #AAAAAA } /* Generic.Output */
.highlight .gp { color: #000099; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold; } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { font-weight: bold } /* Keyword.Constant */
.highlight .kd { font-weight: bold } /* Keyword.Declaration */
.highlight .kn { font-weight: bold } /* Keyword.Namespace */
.highlight .kp { font-weight: bold } /* Keyword.Pseudo */
.highlight .kr { font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #009999 } /* Literal.Number */
.highlight .s { color: #d14 } /* Literal.String */
.highlight .na { color: #008080 } /* Name.Attribute */
.highlight .nb { color: #0086B3 } /* Name.Builtin */
.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
.highlight .no { color: #008080 } /* Name.Constant */
.highlight .ni { color: #800080 } /* Name.Entity */
.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
.highlight .nn { color: #555555 } /* Name.Namespace */
.highlight .nt { color: #000080 } /* Name.Tag */
.highlight .nv { color: #008080 } /* Name.Variable */
.highlight .ow { font-weight: bold } /* Operator.Word */
.highlight .gu { color: #003300; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #99CC66 } /* Generic.Traceback */
.highlight .kc { color: #006699; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #006699; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #006699; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #006699 } /* Keyword.Pseudo */
.highlight .kr { color: #006699; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #007788; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #FF6600 } /* Literal.Number */
.highlight .s { color: #CC3300 } /* Literal.String */
.highlight .na { color: #330099 } /* Name.Attribute */
.highlight .nb { color: #336666 } /* Name.Builtin */
.highlight .nc { color: #00AA88; font-weight: bold } /* Name.Class */
.highlight .no { color: #336600 } /* Name.Constant */
.highlight .nd { color: #9999FF } /* Name.Decorator */
.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #CC0000; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #CC00FF } /* Name.Function */
.highlight .nl { color: #9999FF } /* Name.Label */
.highlight .nn { color: #00CCFF; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #330099; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #003333 } /* Name.Variable */
.highlight .ow { color: #000000; font-weight: bold } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mf { color: #009999 } /* Literal.Number.Float */
.highlight .mh { color: #009999 } /* Literal.Number.Hex */
.highlight .mi { color: #009999 } /* Literal.Number.Integer */
.highlight .mo { color: #009999 } /* Literal.Number.Oct */
.highlight .sb { color: #d14 } /* Literal.String.Backtick */
.highlight .sc { color: #d14 } /* Literal.String.Char */
.highlight .sd { color: #d14 } /* Literal.String.Doc */
.highlight .s2 { color: #d14 } /* Literal.String.Double */
.highlight .se { color: #d14 } /* Literal.String.Escape */
.highlight .sh { color: #d14 } /* Literal.String.Heredoc */
.highlight .si { color: #d14 } /* Literal.String.Interpol */
.highlight .sx { color: #d14 } /* Literal.String.Other */
.highlight .sr { color: #009926 } /* Literal.String.Regex */
.highlight .s1 { color: #d14 } /* Literal.String.Single */
.highlight .ss { color: #990073 } /* Literal.String.Symbol */
.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
.highlight .vc { color: #008080 } /* Name.Variable.Class */
.highlight .vg { color: #008080 } /* Name.Variable.Global */
.highlight .vi { color: #008080 } /* Name.Variable.Instance */
.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */
.highlight .mf { color: #FF6600 } /* Literal.Number.Float */
.highlight .mh { color: #FF6600 } /* Literal.Number.Hex */
.highlight .mi { color: #FF6600 } /* Literal.Number.Integer */
.highlight .mo { color: #FF6600 } /* Literal.Number.Oct */
.highlight .sb { color: #CC3300 } /* Literal.String.Backtick */
.highlight .sc { color: #CC3300 } /* Literal.String.Char */
.highlight .sd { color: #CC3300; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #CC3300 } /* Literal.String.Double */
.highlight .se { color: #CC3300; font-weight: bold } /* Literal.String.Escape */
.highlight .sh { color: #CC3300 } /* Literal.String.Heredoc */
.highlight .si { color: #AA0000 } /* Literal.String.Interpol */
.highlight .sx { color: #CC3300 } /* Literal.String.Other */
.highlight .sr { color: #33AAAA } /* Literal.String.Regex */
.highlight .s1 { color: #CC3300 } /* Literal.String.Single */
.highlight .ss { color: #FFCC33 } /* Literal.String.Symbol */
.highlight .bp { color: #336666 } /* Name.Builtin.Pseudo */
.highlight .vc { color: #003333 } /* Name.Variable.Class */
.highlight .vg { color: #003333 } /* Name.Variable.Global */
.highlight .vi { color: #003333 } /* Name.Variable.Instance */
.highlight .il { color: #FF6600 } /* Literal.Number.Integer.Long */
.type-csharp .highlight .k { color: #0000FF }
.type-csharp .highlight .kt { color: #0000FF }
......
This diff is collapsed.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment