comparison tools/sample_seqs/README.rst @ 6:31f5701cd2e9 draft

v0.2.4 Depends on Biopython 1.67 via legacy Tool Shed package or bioconda.
author peterjc
date Thu, 11 May 2017 07:24:38 -0400
parents 6b71ad5d43fb
children 86710edcec02
comparison
equal deleted inserted replaced
5:6b71ad5d43fb 6:31f5701cd2e9
1 Galaxy tool to sub-sample sequence files 1 Galaxy tool to sub-sample sequence files
2 ======================================== 2 ========================================
3 3
4 This tool is copyright 2014-2015 by Peter Cock, The James Hutton Institute 4 This tool is copyright 2014-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 (using Biopython library functions) 8 This tool is a short Python script (using Biopython library functions)
9 to sub-sample sequence files (in a range of formats including FASTA, FASTQ, 9 to sub-sample sequence files (in a range of formats including FASTA, FASTQ,
69 v0.2.2 - Reorder XML elements (internal change only). 69 v0.2.2 - Reorder XML elements (internal change only).
70 - Use ``format_source=...`` tag. 70 - Use ``format_source=...`` tag.
71 - Planemo for Tool Shed upload (``.shed.yml``, internal change only). 71 - Planemo for Tool Shed upload (``.shed.yml``, internal change only).
72 v0.2.3 - Do the Biopython imports at the script start (internal change only). 72 v0.2.3 - Do the Biopython imports at the script start (internal change only).
73 - Clarify paired read example in help text. 73 - Clarify paired read example in help text.
74 v0.2.4 - Depends on Biopython 1.67 via legacy Tool Shed package or bioconda.
75 - Style changes to Python code (internal change only).
74 ======= ====================================================================== 76 ======= ======================================================================
75 77
76 78
77 Developers 79 Developers
78 ========== 80 ==========
82 84
83 For pushing a release to the test or main "Galaxy Tool Shed", use the following 85 For pushing a release to the test or main "Galaxy Tool Shed", use the following
84 Planemo commands (which requires you have set your Tool Shed access details in 86 Planemo commands (which requires you have set your Tool Shed access details in
85 ``~/.planemo.yml`` and that you have access rights on the Tool Shed):: 87 ``~/.planemo.yml`` and that you have access rights on the Tool Shed)::
86 88
87 $ planemo shed_update -t testtoolshed --check_diff ~/repositories/pico_galaxy/tools/sample_seqs/ 89 $ planemo shed_update -t testtoolshed --check_diff tools/sample_seqs/
88 ... 90 ...
89 91
90 or:: 92 or::
91 93
92 $ planemo shed_update -t toolshed --check_diff ~/repositories/pico_galaxy/tools/sample_seqs/ 94 $ planemo shed_update -t toolshed --check_diff tools/sample_seqs/
93 ... 95 ...
94 96
95 To just build and check the tar ball, use:: 97 To just build and check the tar ball, use::
96 98
97 $ planemo shed_upload --tar_only ~/repositories/pico_galaxy/tools/sample_seqs/ 99 $ planemo shed_upload --tar_only tools/sample_seqs/
98 ... 100 ...
99 $ tar -tzf shed_upload.tar.gz 101 $ tar -tzf shed_upload.tar.gz
100 test-data/MID4_GLZRM4E04_rnd30_frclip.pair_sample_N5.sff 102 test-data/MID4_GLZRM4E04_rnd30_frclip.pair_sample_N5.sff
101 test-data/MID4_GLZRM4E04_rnd30_frclip.sff 103 test-data/MID4_GLZRM4E04_rnd30_frclip.sff
102 test-data/MID4_GLZRM4E04_rnd30_frclip.sample_C1.sff 104 test-data/MID4_GLZRM4E04_rnd30_frclip.sample_C1.sff