Mercurial > repos > peterjc > fastq_paired_unpaired
annotate tools/fastq/fastq_paired_unpaired.rst @ 3:528ba9c896e0 draft
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
author | peterjc |
---|---|
date | Wed, 18 Sep 2013 06:13:27 -0400 |
parents | |
children |
rev | line source |
---|---|
3
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
1 Galaxy tool to divide FASTQ files into paired and unpaired reads |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
2 ================================================================ |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
3 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
4 This tool is copyright 2010-2013 by Peter Cock, The James Hutton Institute |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
5 (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved. |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
6 See the licence text below (MIT licence). |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
7 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
8 This tool is a short Python script which divides a FASTQ file into paired |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
9 reads, and single or orphan reads. You can have separate files for the |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
10 forward/reverse reads, or have them interleaved in a single file. |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
11 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
12 Note that the FASTQ variant is unimportant (Sanger, Solexa, Illumina, or even |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
13 Color Space should all work equally well). |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
14 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
15 This tool is available from the Galaxy Tool Shed at: |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
16 http://toolshed.g2.bx.psu.edu/view/peterjc/fastq_paired_unpaired |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
17 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
18 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
19 Automated Installation |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
20 ====================== |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
21 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
22 This should be straightforward, Galaxy should automatically download and install |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
23 the tool from the Galaxy Tool Shed, and run the unit tests |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
24 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
25 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
26 Manual Installation |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
27 =================== |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
28 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
29 There are just two files to install: |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
30 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
31 * fastq_paired_unpaired.py (the Python script) |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
32 * fastq_paired_unpaired.xml (the Galaxy tool definition) |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
33 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
34 The suggested location is in the Galaxy folder tools/fastq next to other FASTQ |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
35 tools provided with Galaxy. |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
36 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
37 You will also need to modify the tools_conf.xml file to tell Galaxy to offer |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
38 the tool. One suggested location is next to the fastq_filter.xml entry. Simply |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
39 add the line:: |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
40 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
41 <tool file="fastq/fastq_paired_unpaired.xml" /> |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
42 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
43 That's it. |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
44 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
45 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
46 History |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
47 ======= |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
48 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
49 ======= ====================================================================== |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
50 Version Changes |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
51 ------- ---------------------------------------------------------------------- |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
52 v0.0.1 - Initial version, using Biopython |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
53 v0.0.2 - Help text; cope with multiple pairs per template |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
54 v0.0.3 - Galaxy XML wrappers added |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
55 v0.0.4 - Use Galaxy library to handle FASTQ files (avoid Biopython dependency) |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
56 v0.0.5 - Handle Illumina 1.8 style pair names |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
57 v0.0.6 - Record script version when run from Galaxy |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
58 - Added unit test (FASTQ file using Sanger naming) |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
59 v0.0.7 - Link to Tool Shed added to help text and this documentation. |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
60 v0.0.8 - Use reStructuredText for this README file. |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
61 - Adopt standard MIT License. |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
62 - Updated citation information (Cock et al. 2013). |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
63 ======= ====================================================================== |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
64 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
65 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
66 Developers |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
67 ========== |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
68 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
69 This script and other tools for filtering FASTA, FASTQ and SFF files were |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
70 initially developed on the following hg branch: |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
71 http://bitbucket.org/peterjc/galaxy-central/src/fasta_filter |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
72 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
73 Development has now moved to a dedicated GitHub repository: |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
74 https://github.com/peterjc/pico_galaxy/tree/master/tools/ |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
75 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
76 For making the "Galaxy Tool Shed" http://toolshed.g2.bx.psu.edu/ tarball use |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
77 the following command from the Galaxy root folder:: |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
78 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
79 $ tar -czf fastq_paired_unpaired.tar.gz tools/fastq/fastq_paired_unpaired.* test-data/sanger-pairs-*.fastq |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
80 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
81 Check this worked:: |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
82 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
83 $ tar -tzf fastq_paired_unpaired.tar.gz |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
84 tools/fastq/fastq_paired_unpaired.py |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
85 tools/fastq/fastq_paired_unpaired.rst |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
86 tools/fastq/fastq_paired_unpaired.xml |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
87 test-data/sanger-pairs-forward.fastq |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
88 test-data/sanger-pairs-interleaved.fastq |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
89 test-data/sanger-pairs-mixed.fastq |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
90 test-data/sanger-pairs-reverse.fastq |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
91 test-data/sanger-pairs-singles.fastq |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
92 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
93 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
94 Licence (MIT) |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
95 ============= |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
96 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
97 Permission is hereby granted, free of charge, to any person obtaining a copy |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
98 of this software and associated documentation files (the "Software"), to deal |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
99 in the Software without restriction, including without limitation the rights |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
100 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
101 copies of the Software, and to permit persons to whom the Software is |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
102 furnished to do so, subject to the following conditions: |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
103 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
104 The above copyright notice and this permission notice shall be included in |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
105 all copies or substantial portions of the Software. |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
106 |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
107 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
108 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
109 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
110 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
111 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
112 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
528ba9c896e0
Uploaded v0.0.8, MIT licence and reST for README, citation information, development moved to GitHub
peterjc
parents:
diff
changeset
|
113 THE SOFTWARE. |