comparison tools/fastq_paired_unpaired/README.rst @ 6:f396701fbf32 draft

v0.1.3 Depends on Biopython 1.67 via Tool Shed package or bioconda.
author peterjc
date Wed, 10 May 2017 13:28:59 -0400
parents b38bbcbd458d
children 2709a0f065c9
comparison
equal deleted inserted replaced
5:b38bbcbd458d 6:f396701fbf32
1 Galaxy tool to divide FASTQ files into paired and unpaired reads 1 Galaxy tool to divide FASTQ files into paired and unpaired reads
2 ================================================================ 2 ================================================================
3 3
4 This tool is copyright 2010-2015 by Peter Cock, The James Hutton Institute 4 This tool is copyright 2010-2017 by Peter Cock, The James Hutton Institute
5 (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved. 5 (formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved.
6 See the licence text below (MIT licence). 6 See the licence text below (MIT licence).
7 7
8 This tool is a short Python script which divides a FASTQ file into paired 8 This tool is a short Python script which divides a FASTQ file into paired
9 reads, and single or orphan reads. You can have separate files for the 9 reads, and single or orphan reads. You can have separate files for the
69 - Tool definition now embeds citation information. 69 - Tool definition now embeds citation information.
70 v0.1.1 - Reorder XML elements (internal change only). 70 v0.1.1 - Reorder XML elements (internal change only).
71 - Use ``format_source=...`` tag. 71 - Use ``format_source=...`` tag.
72 - Planemo for Tool Shed upload (``.shed.yml``, internal change only). 72 - Planemo for Tool Shed upload (``.shed.yml``, internal change only).
73 v0.1.2 - Belatedly declare Biopython dependency via Tool Shed. 73 v0.1.2 - Belatedly declare Biopython dependency via Tool Shed.
74 v0.1.3 - Minor internal changes to Python script for error reporting & style.
75 - Updated to point at Biopython 1.67 (latest version in Tool Shed).
76 - Explicit dependency on ``galaxy_sequence_utils``.
74 ======= ====================================================================== 77 ======= ======================================================================
75 78
76 79
77 Developers 80 Developers
78 ========== 81 ==========
86 89
87 For pushing a release to the test or main "Galaxy Tool Shed", use the following 90 For pushing a release to the test or main "Galaxy Tool Shed", use the following
88 Planemo commands (which requires you have set your Tool Shed access details in 91 Planemo commands (which requires you have set your Tool Shed access details in
89 ``~/.planemo.yml`` and that you have access rights on the Tool Shed):: 92 ``~/.planemo.yml`` and that you have access rights on the Tool Shed)::
90 93
91 $ planemo shed_update --shed_target testtoolshed --check_diff ~/repositories/pico_galaxy/tools/fastq_paired_unpaired/ 94 $ planemo shed_update -t testtoolshed --check_diff tools/fastq_paired_unpaired/
92 ... 95 ...
93 96
94 or:: 97 or::
95 98
96 $ planemo shed_update --shed_target toolshed --check_diff ~/repositories/pico_galaxy/tools/fastq_paired_unpaired/ 99 $ planemo shed_update -t toolshed --check_diff tools/fastq_paired_unpaired/
97 ... 100 ...
98 101
99 To just build and check the tar ball, use:: 102 To just build and check the tar ball, use::
100 103
101 $ planemo shed_upload --tar_only ~/repositories/pico_galaxy/tools/fastq_paired_unpaired/ 104 $ planemo shed_upload --tar_only tools/fastq_paired_unpaired/
102 ... 105 ...
103 $ tar -tzf shed_upload.tar.gz 106 $ tar -tzf shed_upload.tar.gz
104 test-data/sanger-pairs-forward.fastq 107 test-data/sanger-pairs-forward.fastq
105 test-data/sanger-pairs-interleaved.fastq 108 test-data/sanger-pairs-interleaved.fastq
106 test-data/sanger-pairs-mixed.fastq 109 test-data/sanger-pairs-mixed.fastq