Mercurial > repos > peterjc > seq_primer_clip
annotate tools/seq_primer_clip/README.rst @ 4:9b074c1db68e draft
v0.0.14 galaxy_sequence_utils dependency etc
author | peterjc |
---|---|
date | Thu, 02 Feb 2017 11:52:37 -0500 |
parents | 708ce1e5ac94 |
children | 530c8d6fedd8 |
rev | line source |
---|---|
2
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
1 Galaxy tool to primer clip (trim) FASTA, FASTQ or SFF reads |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
2 =========================================================== |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
3 |
4 | 4 This tool is copyright 2011-2017 by Peter Cock, The James Hutton Institute |
2
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
5 (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved. |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
6 See the licence text below (MIT licence). |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
7 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
8 This tool is a short Python script (using the Galaxy library functions and |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
9 Biopython). It is available from the Galaxy Tool Shed here: |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
10 http://toolshed.g2.bx.psu.edu/view/peterjc/seq_primer_clip |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
11 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
12 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
13 Automated Installation |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
14 ====================== |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
15 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
16 This should be straightforward using the Galaxy Tool Shed, which should be |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
17 able to automatically install the dependency on Biopython, and then install |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
18 this tool and run its unit tests. |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
19 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
20 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
21 Manual Installation |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
22 =================== |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
23 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
24 There are just two files to install: |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
25 |
4 | 26 * ``seq_primer_clip.py`` (the Python script) |
27 * ``seq_primer_clip.xml`` (the Galaxy tool definition) | |
2
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
28 |
4 | 29 The suggested location is a new ``tools/seq_primer_clip/`` folder. You will |
30 also need to modify the ``tools_conf.xml`` file to tell Galaxy to offer the | |
31 tool:: | |
2
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
32 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
33 <tool file="seq_primer_clip/seq_primer_clip.xml" /> |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
34 |
4 | 35 If you wish to run the unit tests, also move/copy the ``test-data/`` files |
36 under Galaxy's ``test-data/`` folder. Then:: | |
2
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
37 |
4 | 38 $ ./run_tests.sh -id seq_primer_clip |
2
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
39 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
40 You will also need to install Biopython 1.54 or later. That's it. |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
41 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
42 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
43 History |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
44 ======= |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
45 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
46 ======= ====================================================================== |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
47 Version Changes |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
48 ------- ---------------------------------------------------------------------- |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
49 v0.0.1 - Initial version (not publicly released) |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
50 v0.0.2 - Sort primers by length (longest and therefore most specific first) |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
51 v0.0.3 - Consider missing bases at start/end of read as mismatches |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
52 v0.0.4 - Apply minimum length to sequences with no match too |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
53 v0.0.5 - Count clipped & non-matched short reads separately, length bug fixes |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
54 v0.0.6 - Added some functional tests |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
55 v0.0.7 - Added error check for bad filename arguments |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
56 v0.0.8 - Record version of Python script when run from Galaxy. |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
57 - Check for errors using Python script's return code. |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
58 v0.0.9 - Moved test data to workaround Galaxy Tool Shed limititation. |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
59 v0.0.10 - Include links to Tool Shed in help text and this README file. |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
60 - Use reStructuredText for this README file. |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
61 - Adopted standard MIT licence. |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
62 - Automated installation of Biopython dependency. |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
63 - Development moved to GitHub, https://github.com/peterjc/pico_galaxy |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
64 - Renamed folder and adopted README.rst naming. |
3
708ce1e5ac94
Uploaded v0.0.11, corrected automated dependency definition
peterjc
parents:
2
diff
changeset
|
65 v0.0.11 - Correct automated dependency definition. |
4 | 66 v0.0.12 - Simplified XML to apply input format to output data. |
67 - Tool definition now embeds citation information. | |
68 v0.0.13 - Use ``format_source=...`` tag. | |
69 - Reorder XML elements (internal change only). | |
70 - Planemo for Tool Shed upload (``.shed.yml``, internal change only). | |
71 - Fixed input file help text. | |
72 v0.0.14 - Updated to point at Biopython 1.67 (latest version in Tool Shed). | |
73 - Explicit dependency on ``galaxy_sequence_utils``. | |
2
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
74 ======= ====================================================================== |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
75 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
76 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
77 Developers |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
78 ========== |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
79 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
80 This script and related tools were initially developed on the following hg branches: |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
81 http://bitbucket.org/peterjc/galaxy-central/src/fasta_filter |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
82 http://bitbucket.org/peterjc/galaxy-central/src/tools |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
83 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
84 Development has now moved to a dedicated GitHub repository: |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
85 https://github.com/peterjc/pico_galaxy |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
86 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
87 |
4 | 88 For pushing a release to the test or main "Galaxy Tool Shed", use the following |
89 Planemo commands (which requires you have set your Tool Shed access details in | |
90 ``~/.planemo.yml`` and that you have access rights on the Tool Shed):: | |
2
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
91 |
4 | 92 $ planemo shed_update -t testtoolshed --check_diff ~/repositories/pico_galaxy/tools/seq_primer_clip/ |
93 ... | |
2
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
94 |
4 | 95 or:: |
96 | |
97 $ planemo shed_update -t toolshed --check_diff ~/repositories/pico_galaxy/tools/seq_primer_clip/ | |
98 ... | |
99 | |
100 To just build and check the tar ball, use:: | |
101 | |
102 $ planemo shed_upload --tar_only ~/repositories/pico_galaxy/tools/seq_primer_clip/ | |
103 ... | |
104 $ tar -tzf shed_upload.tar.gz | |
2
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
105 test-data/MID4_GLZRM4E04_rnd30.fasta |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
106 test-data/MID4_GLZRM4E04_rnd30.fastqsanger |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
107 test-data/MID4_GLZRM4E04_rnd30_fclip.fasta |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
108 test-data/MID4_GLZRM4E04_rnd30_fclip.fastqsanger |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
109 test-data/MID4_GLZRM4E04_rnd30_fclip.sff |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
110 test-data/MID4_GLZRM4E04_rnd30_frclip.fasta |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
111 test-data/MID4_GLZRM4E04_rnd30_frclip.fastqsanger |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
112 test-data/MID4_GLZRM4E04_rnd30_frclip.sff |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
113 test-data/MID4_GLZRM4E04_rnd30.sff |
4 | 114 test-data/dop_primers.fasta |
115 tools/seq_primer_clip/README.rst | |
116 tools/seq_primer_clip/seq_primer_clip.py | |
117 tools/seq_primer_clip/seq_primer_clip.xml | |
118 tools/seq_primer_clip/tool_dependencies.xml | |
2
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
119 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
120 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
121 Licence (MIT) |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
122 ============= |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
123 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
124 Permission is hereby granted, free of charge, to any person obtaining a copy |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
125 of this software and associated documentation files (the "Software"), to deal |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
126 in the Software without restriction, including without limitation the rights |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
127 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
128 copies of the Software, and to permit persons to whom the Software is |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
129 furnished to do so, subject to the following conditions: |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
130 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
131 The above copyright notice and this permission notice shall be included in |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
132 all copies or substantial portions of the Software. |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
133 |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
134 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
135 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
136 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
137 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
138 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
139 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
ee5acea162a7
Uploaded v0.0.10, README now using RST, MIT licence, automatic Biopython dependency
peterjc
parents:
diff
changeset
|
140 THE SOFTWARE. |