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