Mercurial > repos > peterjc > fastq_paired_unpaired

annotate tools/fastq/fastq_paired_unpaired.txt @ 1:7ed81e36fc1c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded v0.0.5 which handles Illumina 1.8 style pair naming.
author peterjc
date Mon, 12 Dec 2011 11:33:10 -0500
parents 72e9fcaec61f
children 95a632a71951
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
1 Galaxy tool to divide FASTQ files into paired and unpaired reads
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
2 ================================================================
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
3
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
4 This tool is copyright 2010 by Peter Cock, SCRI, UK. All rights reserved.
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
5 See the licence text below.
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
6
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
7 This tool is a short Python script (using the Biopython library functions) which
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
8 divides a FASTQ file into paired reads, and single or orphan reads. You can have
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
9 separate files for the forward/reverse reads, or have them interleaved in a
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
10 single file.
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
11
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
12 Note that the FASTQ variant is unimportant (Sanger, Solexa, Illumina, or even
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
13 Color Space should all work equally well).
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
14
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
15 There are just two files to install:
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
16
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
17 * fastq_paired_unpaired.py (the Python script)
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
18 * fastq_paired_unpaired.xml (the Galaxy tool definition)
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
19
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
20 The suggested location is in the Galaxy folder tools/fastq next to other FASTQ
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
21 tools provided with Galaxy.
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
22
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
23 You will also need to modify the tools_conf.xml file to tell Galaxy to offer
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
24 the tool. One suggested location is next to the fastq_filter.xml entry. Simply
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
25 add the line:
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
26
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
27 <tool file="fastq/fastq_paired_unpaired.xml" />
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
28
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
29 That's it.
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
30
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
31
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
32 History
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
33 =======
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
34
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
35 v0.0.1 - Initial version, using Biopython
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
36 v0.0.2 - Help text; cope with multiple pairs per template
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
37 v0.0.3 - Galaxy XML wrappers added
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
38 v0.0.4 - Use Galaxy library to handle FASTQ files (avoid Biopython dependency)
1
7ed81e36fc1c Uploaded v0.0.5 which handles Illumina 1.8 style pair naming.
peterjc
parents: 0
diff changeset
39 v0.0.5 - Handle Illumina 1.8 style pair names
0
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
40
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
41
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
42 Developers
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
43 ==========
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
44
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
45 This script and other tools for filtering FASTA, FASTQ and SFF files are
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
46 currently being developed on the following hg branch:
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
47 http://bitbucket.org/peterjc/galaxy-central/src/fasta_filter
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
48
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
49 For making the "Galaxy Tool Shed" http://community.g2.bx.psu.edu/ tarball use
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
50 the following command from the Galaxy root folder:
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
51
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
52 tar -czf fastq_paired_unpaired.tar.gz tools/fastq/fastq_paired_unpaired.*
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
53
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
54 Check this worked:
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
55
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
56 $ tar -tzf fastq_paired_unpaired.tar.gz
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
57 fastq/fastq_paired_unpaired.py
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
58 fastq/fastq_paired_unpaired.txt
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
59 fastq/fastq_paired_unpaired.xml
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
60
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
61
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
62 Licence (MIT/BSD style)
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
63 =======================
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
64
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
65 Permission to use, copy, modify, and distribute this software and its
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
66 documentation with or without modifications and for any purpose and
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
67 without fee is hereby granted, provided that any copyright notices
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
68 appear in all copies and that both those copyright notices and this
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
69 permission notice appear in supporting documentation, and that the
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
70 names of the contributors or copyright holders not be used in
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
71 advertising or publicity pertaining to distribution of the software
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
72 without specific prior permission.
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
73
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
74 THE CONTRIBUTORS AND COPYRIGHT HOLDERS OF THIS SOFTWARE DISCLAIM ALL
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
75 WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
76 WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
77 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
78 OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
79 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
80 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
72e9fcaec61f Migrated tool version 0.0.4 from old tool shed archive to new tool shed repository
peterjc
parents:
diff changeset
81 OR PERFORMANCE OF THIS SOFTWARE.