annotate README @ 16:42f66e55b26b

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