annotate fastq_groomer_parallel/README @ 7:6696b5d4ebc3 draft default tip

Uploaded
author kevyin
date Fri, 20 Apr 2018 22:57:42 -0400
parents b3db1d953414
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
1 Copyright (c) 2012, Kenneth Sabir
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
2 Copyright (c) 2016, Kevin Ying
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
3 All rights reserved.
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
4
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
5 Redistribution and use in source and binary forms, with or without modification, are permitted provided
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
6 that the following conditions are met:
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
7
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
8 - Redistributions of source code must retain the above copyright notice, this list of conditions and
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
9 the following disclaimer.
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
10 - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
11 the following disclaimer in the documentation and/or other materials provided with the distribution.
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
12 - Neither the name of the Garvan Institute nor the names of its contributors may be used to endorse
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
13 or promote products derived from this software without specific prior written permission.
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
14
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
15 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
16 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
17 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
18 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
19 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
20 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
21 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
22
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
23 ##################################################
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
24 INSTALLATION:
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
25 #================================================#
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
26
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
27 Set the number of threads to use by editing:
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
28 fastq_groomer_parallel.xml:
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
29 Modify the last argument in the <command> tag, Default is 8
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
30
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
31 Tested on galaxy-dist -r e6444e7a1685
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
32 This currently depends on the following galaxy_utils python library which should come with the default galaxy install
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
33
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
34 More info:
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
35 from galaxy_utils.sequence.fastq import fastqReader, fastqVerboseErrorReader, fastqAggregator, fastqWriter
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
36 v0.3.2 Explicit dependency on ``galaxy_sequence_utils``
b3db1d953414 Uploaded
kevyin
parents:
diff changeset
37 ##################################################