Commit a0b6e006 authored by adrien's avatar adrien
Browse files

Create gh-pages branch via GitHub

parents
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>Sekator by a-slide</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" type="text/css" href="stylesheets/normalize.css" media="screen">
<link href='http://fonts.googleapis.com/css?family=Open+Sans:400,700' 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/github-light.css" media="screen">
</head>
<body>
<section class="page-header">
<h1 class="project-name">Sekator</h1>
<h2 class="project-tagline">Multithreaded quality and adapter trimmer for PAIRED fastq files (Python2.7/Cython/C)</h2>
<a href="https://github.com/a-slide/Sekator" class="btn">View on GitHub</a>
<a href="https://github.com/a-slide/Sekator/zipball/master" class="btn">Download .zip</a>
<a href="https://github.com/a-slide/Sekator/tarball/master" class="btn">Download .tar.gz</a>
</section>
<section class="main-content">
<h1>
<a id="sekator-02" class="anchor" href="#sekator-02" aria-hidden="true"><span class="octicon octicon-link"></span></a>Sekator 0.2</h1>
<p><strong>Multithreaded quality and adapter trimmer for PAIRED fastq files (Python2.7/Cython/C)</strong></p>
<p><strong>Creation : 2015/03/31</strong></p>
<p><strong>Last update : 2015/03/31</strong> </p>
<h2>
<a id="motivation" class="anchor" href="#motivation" aria-hidden="true"><span class="octicon octicon-link"></span></a>Motivation</h2>
<p>Sekator is a <strong>python2.7, cython 0.21+, C</strong> object oriented semi-compiled program performing fastq quality trimming and adapter trimming</p>
<p>Specific features:</p>
<ul>
<li>The program can parse a pair of fastq files files per sample, but many samples can be analysed together.</li>
<li>Fastq reading and writing are mono-threaded, but the trimming steps are multi-threaded.</li>
<li>The quality trimming step can be performed from both ends of reads with an adjustable sliding windows.</li>
<li>The adapter trimming step is performed by searching imperfect matches of as many adapters as desired (or short sequences) thanks to a fast Smith and Waterman Algorithm coded in C (maintained by <a href="https://github.com/mengyao/Complete-Striped-Smith-Waterman-Library">Mengyao</a>).</li>
</ul>
<h2>
<a id="principle" class="anchor" href="#principle" aria-hidden="true"><span class="octicon octicon-link"></span></a>Principle</h2>
<ol>
<li>A configuration file containing all program parameters (including sample/adpater association) is parsed and thoroughly verified for validity.</li>
<li>Paired fastq paired files are read read by read and sample by sample with a custom Fastq parser supporting <strong>Illumina 1.8 Phred+33 quality encoding only</strong>.</li>
<li>If required, a quality trimming of reads can be performed with a quality sliding windows, starting from both ends of reads. Reads of insufficient quality or too short after trimming are discarded, together with their paired mate.</li>
<li>If required, an adapter trimming of reads can be performed with the adapters provided for each sample. <strong>Imperfect matches can be found anywhere in the reads for as many adapters as required</strong> thanks to an optimized and fast Smith and Waterman Algorithm. If adapters matches are found in a read, the longest part of the read without adapter match is extracted. Reads too short after trimming are discarded, together with their paired mate.</li>
<li>The paired reads that passed thought the trimming steps are subsequently writen in new fastq.gz files (R1 and R2) in Illumina 1.8 Phred+33 quality encoding.</li>
<li>A progress bar indicates the advancement of sequence processing and a report is generated for each sample. </li>
</ol>
<h2>
<a id="dependencies" class="anchor" href="#dependencies" aria-hidden="true"><span class="octicon octicon-link"></span></a>Dependencies</h2>
<p>The program was developed under Linux Mint 17 and was not tested with other OS.
In addition to python2.7 and gcc 4.8 + the following dependencies are required for proper program execution:</p>
<ul>
<li>cython 0.21.2+</li>
<li>python package <a href="http://www.numpy.org/">numpy</a> 1.7.1+</li>
</ul>
<p>If you have pip already installed, enter the following line to install packages: <code>sudo pip install numpy cython</code></p>
<h2>
<a id="get-and-install-sekator" class="anchor" href="#get-and-install-sekator" aria-hidden="true"><span class="octicon octicon-link"></span></a>Get and install Sekator</h2>
<ul>
<li><p>Clone the repository or download the archive <code>git clone https://github.com/a-slide/Sekator.git</code></p></li>
<li><p>Enter the src folder of the program folder</p></li>
<li><p>Compile the C/Cython sources with the Makefile <code>make</code> or the setup.py <code>python setup.py build_ext --inplace</code>. This will create the dynamic library AdapterTrimmer.so required for the adapter trimming step.</p></li>
<li><p>Unnecessary files can be removed with the makefile <code>make clean</code></p></li>
<li><p>Make the main script executable <code>sudo chmod u+x Sekator.py</code></p></li>
<li><p>Finally, add Sekator.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 created</p>
<p>Usage: Sekator.py -c Conf.txt [-i -h]</p>
<pre><code>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 [Mandatory]
-i Generate an example configuration file and exit [Facultative]
</code></pre>
<p>An example configuration file can be generated by running the program with the option -i
The possible options are extensively described 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
Sekator.py -i
Sekator.py -c Sekator_conf_file.txt
</code></pre>
<h2>
<a id="authors-and-contact" class="anchor" href="#authors-and-contact" aria-hidden="true"><span class="octicon octicon-link"></span></a>Authors and Contact</h2>
<p>Adrien Leger - 2014</p>
<ul>
<li>
<a href="mailto:adrien.leger@gmail.com">adrien.leger@gmail.com</a> - <a href="mailto:adrien.leger@inserm.fr">adrien.leger@inserm.fr</a> - <a href="mailto:adrien.leger@univ-nantes.fr">adrien.leger@univ-nantes.fr</a>
</li>
<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>
<footer class="site-footer">
<span class="site-footer-owner"><a href="https://github.com/a-slide/Sekator">Sekator</a> is maintained by <a href="https://github.com/a-slide">a-slide</a>.</span>
<span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a> using the <a href="https://github.com/jasonlong/cayman-theme">Cayman theme</a> by <a href="https://twitter.com/jasonlong">Jason Long</a>.</span>
</footer>
</section>
</body>
</html>
{"name":"Sekator","tagline":"Multithreaded quality and adapter trimmer for PAIRED fastq files (Python2.7/Cython/C)","body":"# Sekator 0.2\r\n\r\n**Multithreaded quality and adapter trimmer for PAIRED fastq files (Python2.7/Cython/C)**\r\n\r\n**Creation : 2015/03/31**\r\n\r\n**Last update : 2015/03/31** \r\n\r\n## Motivation\r\n\r\nSekator is a **python2.7, cython 0.21+, C** object oriented semi-compiled program performing fastq quality trimming and adapter trimming\r\n\r\nSpecific features:\r\n\r\n* The program can parse a pair of fastq files files per sample, but many samples can be analysed together.\r\n* Fastq reading and writing are mono-threaded, but the trimming steps are multi-threaded.\r\n* The quality trimming step can be performed from both ends of reads with an adjustable sliding windows.\r\n* The adapter trimming step is performed by searching imperfect matches of as many adapters as desired (or short sequences) thanks to a fast Smith and Waterman Algorithm coded in C (maintained by [Mengyao](https://github.com/mengyao/Complete-Striped-Smith-Waterman-Library)).\r\n\r\n## Principle\r\n\r\n1. A configuration file containing all program parameters (including sample/adpater association) is parsed and thoroughly verified for validity.\r\n2. Paired fastq paired files are read read by read and sample by sample with a custom Fastq parser supporting **Illumina 1.8 Phred+33 quality encoding only**.\r\n3. If required, a quality trimming of reads can be performed with a quality sliding windows, starting from both ends of reads. Reads of insufficient quality or too short after trimming are discarded, together with their paired mate.\r\n4. If required, an adapter trimming of reads can be performed with the adapters provided for each sample. **Imperfect matches can be found anywhere in the reads for as many adapters as required** thanks to an optimized and fast Smith and Waterman Algorithm. If adapters matches are found in a read, the longest part of the read without adapter match is extracted. Reads too short after trimming are discarded, together with their paired mate.\r\n5. The paired reads that passed thought the trimming steps are subsequently writen in new fastq.gz files (R1 and R2) in Illumina 1.8 Phred+33 quality encoding.\r\n6. A progress bar indicates the advancement of sequence processing and a report is generated for each sample. \r\n\r\n## Dependencies\r\n\r\nThe program was developed under Linux Mint 17 and was not tested with other OS.\r\nIn addition to python2.7 and gcc 4.8 + the following dependencies are required for proper program execution:\r\n\r\n* cython 0.21.2+\r\n* python package [numpy](http://www.numpy.org/) 1.7.1+\r\n\r\nIf you have pip already installed, enter the following line to install packages: ```sudo pip install numpy cython```\r\n\r\n## Get and install Sekator\r\n\r\n* Clone the repository or download the archive ```git clone https://github.com/a-slide/Sekator.git```\r\n\r\n* Enter the src folder of the program folder\r\n\r\n* Compile the C/Cython sources with the Makefile ```make``` or the setup.py ```python setup.py build_ext --inplace```. This will create the dynamic library AdapterTrimmer.so required for the adapter trimming step.\r\n\r\n* Unnecessary files can be removed with the makefile ```make clean```\r\n\r\n* Make the main script executable ```sudo chmod u+x Sekator.py```\r\n\r\n* Finally, add Sekator.py to your PATH\r\n\r\n## Usage\r\n\r\nIn the folder where fastq files will be created\r\n\r\nUsage: Sekator.py -c Conf.txt [-i -h]\r\n```\r\nOptions:\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 possible options are extensively described 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\nSekator.py -i\r\nSekator.py -c Sekator_conf_file.txt\r\n```\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
/*
Copyright 2014 GitHub Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
.pl-c /* comment */ {
color: #969896;
}
.pl-c1 /* constant, markup.raw, meta.diff.header, meta.module-reference, meta.property-name, support, support.constant, support.variable, variable.other.constant */,
.pl-s .pl-v /* string variable */ {
color: #0086b3;
}
.pl-e /* entity */,
.pl-en /* entity.name */ {
color: #795da3;
}
.pl-s .pl-s1 /* string source */,
.pl-smi /* storage.modifier.import, storage.modifier.package, storage.type.java, variable.other, variable.parameter.function */ {
color: #333;
}
.pl-ent /* entity.name.tag */ {
color: #63a35c;
}
.pl-k /* keyword, storage, storage.type */ {
color: #a71d5d;
}
.pl-pds /* punctuation.definition.string, string.regexp.character-class */,
.pl-s /* string */,
.pl-s .pl-pse .pl-s1 /* string punctuation.section.embedded source */,
.pl-sr /* string.regexp */,
.pl-sr .pl-cce /* string.regexp constant.character.escape */,
.pl-sr .pl-sra /* string.regexp string.regexp.arbitrary-repitition */,
.pl-sr .pl-sre /* string.regexp source.ruby.embedded */ {
color: #183691;
}
.pl-v /* variable */ {
color: #ed6a43;
}
.pl-id /* invalid.deprecated */ {
color: #b52a1d;
}
.pl-ii /* invalid.illegal */ {
background-color: #b52a1d;
color: #f8f8f8;
}
.pl-sr .pl-cce /* string.regexp constant.character.escape */ {
color: #63a35c;
font-weight: bold;
}
.pl-ml /* markup.list */ {
color: #693a17;
}
.pl-mh /* markup.heading */,
.pl-mh .pl-en /* markup.heading entity.name */,
.pl-ms /* meta.separator */ {
color: #1d3e81;
font-weight: bold;
}
.pl-mq /* markup.quote */ {
color: #008080;
}
.pl-mi /* markup.italic */ {
color: #333;
font-style: italic;
}
.pl-mb /* markup.bold */ {
color: #333;
font-weight: bold;
}
.pl-md /* markup.deleted, meta.diff.header.from-file */ {
background-color: #ffecec;
color: #bd2c00;
}
.pl-mi1 /* markup.inserted, meta.diff.header.to-file */ {
background-color: #eaffea;
color: #55a532;
}
.pl-mdr /* meta.diff.range */ {
color: #795da3;
font-weight: bold;
}
.pl-mo /* meta.output */ {
color: #1d3e81;
}
/*! normalize.css v3.0.2 | MIT License | git.io/normalize */
/**
* 1. Set default font family to sans-serif.
* 2. Prevent iOS text size adjust after orientation change, without disabling
* user zoom.
*/
html {
font-family: sans-serif; /* 1 */
-ms-text-size-adjust: 100%; /* 2 */
-webkit-text-size-adjust: 100%; /* 2 */
}
/**
* Remove default margin.
*/
body {
margin: 0;
}
/* HTML5 display definitions
========================================================================== */
/**
* Correct `block` display not defined for any HTML5 element in IE 8/9.
* Correct `block` display not defined for `details` or `summary` in IE 10/11
* and Firefox.
* Correct `block` display not defined for `main` in IE 11.
*/
article,
aside,
details,
figcaption,
figure,
footer,
header,
hgroup,
main,
menu,
nav,
section,
summary {
display: block;
}
/**
* 1. Correct `inline-block` display not defined in IE 8/9.
* 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera.
*/
audio,
canvas,
progress,
video {
display: inline-block; /* 1 */
vertical-align: baseline; /* 2 */
}
/**
* Prevent modern browsers from displaying `audio` without controls.
* Remove excess height in iOS 5 devices.
*/
audio:not([controls]) {
display: none;
height: 0;
}
/**
* Address `[hidden]` styling not present in IE 8/9/10.
* Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22.
*/
[hidden],
template {
display: none;
}
/* Links
========================================================================== */
/**
* Remove the gray background color from active links in IE 10.
*/
a {
background-color: transparent;
}
/**
* Improve readability when focused and also mouse hovered in all browsers.
*/
a:active,
a:hover {
outline: 0;
}
/* Text-level semantics
========================================================================== */
/**
* Address styling not present in IE 8/9/10/11, Safari, and Chrome.
*/
abbr[title] {
border-bottom: 1px dotted;
}
/**
* Address style set to `bolder` in Firefox 4+, Safari, and Chrome.
*/
b,
strong {
font-weight: bold;
}
/**
* Address styling not present in Safari and Chrome.
*/
dfn {
font-style: italic;
}
/**
* Address variable `h1` font-size and margin within `section` and `article`
* contexts in Firefox 4+, Safari, and Chrome.
*/
h1 {
font-size: 2em;
margin: 0.67em 0;
}
/**
* Address styling not present in IE 8/9.
*/
mark {
background: #ff0;
color: #000;
}
/**
* Address inconsistent and variable font size in all browsers.
*/
small {
font-size: 80%;
}
/**
* Prevent `sub` and `sup` affecting `line-height` in all browsers.
*/
sub,
sup {
font-size: 75%;
line-height: 0;
position: relative;
vertical-align: baseline;
}
sup {
top: -0.5em;
}
sub {
bottom: -0.25em;
}
/* Embedded content
========================================================================== */
/**
* Remove border when inside `a` element in IE 8/9/10.
*/
img {
border: 0;
}
/**
* Correct overflow not hidden in IE 9/10/11.
*/
svg:not(:root) {
overflow: hidden;
}
/* Grouping content
========================================================================== */
/**
* Address margin not present in IE 8/9 and Safari.
*/
figure {
margin: 1em 40px;
}
/**
* Address differences between Firefox and other browsers.
*/
hr {
box-sizing: content-box;
height: 0;
}
/**
* Contain overflow in all browsers.
*/
pre {
overflow: auto;
}
/**
* Address odd `em`-unit font size rendering in all browsers.
*/
code,
kbd,
pre,
samp {
font-family: monospace, monospace;
font-size: 1em;
}
/* Forms
========================================================================== */
/**
* Known limitation: by default, Chrome and Safari on OS X allow very limited
* styling of `select`, unless a `border` property is set.
*/
/**
* 1. Correct color not being inherited.
* Known issue: affects color of disabled elements.
* 2. Correct font properties not being inherited.
* 3. Address margins set differently in Firefox 4+, Safari, and Chrome.
*/
button,
input,
optgroup,
select,
textarea {
color: inherit; /* 1 */
font: inherit; /* 2 */
margin: 0; /* 3 */
}
/**
* Address `overflow` set to `hidden` in IE 8/9/10/11.
*/
button {
overflow: visible;
}
/**
* Address inconsistent `text-transform` inheritance for `button` and `select`.
* All other form control elements do not inherit `text-transform` values.
* Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera.
* Correct `select` style inheritance in Firefox.
*/
button,
select {
text-transform: none;
}
/**
* 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`
* and `video` controls.
* 2. Correct inability to style clickable `input` types in iOS.
* 3. Improve usability and consistency of cursor style between image-type
* `input` and others.
*/
button,
html input[type="button"], /* 1 */
input[type="reset"],
input[type="submit"] {
-webkit-appearance: button; /* 2 */
cursor: pointer; /* 3 */
}
/**
* Re-set default cursor for disabled elements.
*/
button[disabled],
html input[disabled] {
cursor: default;
}
/**
* Remove inner padding and border in Firefox 4+.
*/
button::-moz-focus-inner,
input::-moz-focus-inner {
border: 0;
padding: 0;
}
/**
* Address Firefox 4+ setting `line-height` on `input` using `!important` in
* the UA stylesheet.
*/
input {
line-height: normal;
}
/**
* It's recommended that you don't attempt to style these elements.
* Firefox's implementation doesn't respect box-sizing, padding, or width.
*
* 1. Address box sizing set to `content-box` in IE 8/9/10.
* 2. Remove excess padding in IE 8/9/10.
*/
input[type="checkbox"],
input[type="radio"] {
box-sizing: border-box; /* 1 */
padding: 0; /* 2 */
}
/**
* Fix the cursor style for Chrome's increment/decrement buttons. For certain
* `font-size` values of the `input`, it causes the cursor style of the
* decrement button to change from `default` to `text`.
*/
input[type="number"]::-webkit-inner-spin-button,
input[type="number"]::-webkit-outer-spin-button {
height: auto;
}
/**
* 1. Address `appearance` set to `searchfield` in Safari and Chrome.
* 2. Address `box-sizing` set to `border-box` in Safari and Chrome
* (include `-moz` to future-proof).
*/
input[type="search"] {
-webkit-appearance: textfield; /* 1 */ /* 2 */
box-sizing: content-box;
}
/**
* Remove inner padding and search cancel button in Safari and Chrome on OS X.
* Safari (but not Chrome) clips the cancel button when the search input has
* padding (and `textfield` appearance).
*/
input[type="search"]::-webkit-search-cancel-button,
input[type="search"]::-webkit-search-decoration {
-webkit-appearance: none;
}
/**
* Define consistent border, margin, and padding.
*/
fieldset {
border: 1px solid #c0c0c0;
margin: 0 2px;
padding: 0.35em 0.625em 0.75em;
}
/**
* 1. Correct `color` not being inherited in IE 8/9/10/11.
* 2. Remove padding so people aren't caught out if they zero out fieldsets.
*/
legend {
border: 0; /* 1 */