Mercurial > repos > peterjc > samtools_bam2fq
diff tools/samtools_bam2fq/README.rst @ 0:c961d16801e4 draft default tip
Uploaded v0.0.2
author | peterjc |
---|---|
date | Tue, 04 Nov 2014 07:15:50 -0500 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/tools/samtools_bam2fq/README.rst Tue Nov 04 07:15:50 2014 -0500 @@ -0,0 +1,104 @@ +Galaxy wrapper for samtools bam2fq +==================================== + +This wrapper is copyright 2014 by Peter Cock, The James Hutton Institute +(formerly SCRI, Scottish Crop Research Institute), UK. All rights reserved. +See the licence text below. + +This is a wrapper for part of the command line samtools suite. + +This wrapper is available from the Galaxy Tool Shed at: +http://toolshed.g2.bx.psu.edu/view/peterjc/samtools_bam2fq + + +Automated Installation +====================== + +This should be straightforward, Galaxy should automatically download and install +samtools if required. + + +Manual Installation +=================== + +This expects samtools to be on the $PATH, and was tested using v0.1.19. + +To install the wrapper copy or move the following files under the Galaxy tools +folder, e.g. in a ``tools/samtools_bam2fq`` folder: + +* ``samtools_bam2fq.xml`` (the Galaxy tool definition) +* ``README.rst`` (this file) + +You will also need to modify the ``tools_conf.xml`` file to tell Galaxy to offer +the tool. Just add the line, perhaps under the NGS tools section:: + + <tool file="samtools_bam2fq/samtools_bam2fq.xml" /> + +If you wish to run the unit tests, also move/copy the ``test-data/`` files +under Galaxy's ``test-data/`` folder. Then:: + + $ ./run_tests.sh -id samtools_bam2fq + +That's it. + + +History +======= + +======= ====================================================================== +Version Changes +------- ---------------------------------------------------------------------- +v0.0.1 - Initial public release, tested with samtools v1.1. +v0.0.2 - Defaults to pair-aware mode which requires pre-sorting by read name. +======= ====================================================================== + + +Developers +========== + +Development is on this GitHub repository: +https://github.com/peterjc/pico_galaxy/tree/master/tools/samtools_bam2fq + +For making the "Galaxy Tool Shed" http://toolshed.g2.bx.psu.edu/ tarball use +the following command from the Galaxy root folder:: + + $ tar -czf samtools_bam2fq.tar.gz tools/samtools_bam2fq/README.rst tools/samtools_bam2fq/samtools_bam2fq.xml tools/samtools_bam2fq/tool_dependencies.xml test-data/sam_spec_padded.bam test-data/sam_spec_padded.sam test-data/sam_spec_padded.depad.bam test-data/sam_spec_padded.bam2fq.fastq test-data/sam_spec_padded.bam2fq_no_suf.fastq test-data/sam_spec_padded.bam2fq_singles.fastq test-data/sam_spec_padded.bam2fq_pairs.fastq + +Check this worked:: + + $ tar -tzf samtools_bam2fq.tar.gz + tools/samtools_bam2fq/README.rst + tools/samtools_bam2fq/samtools_bam2fq.xml + tools/samtools_bam2fq/tool_dependencies.xml + test-data/sam_spec_padded.bam + test-data/sam_spec_padded.sam + test-data/sam_spec_padded.depad.bam + test-data/sam_spec_padded.bam2fq.fastq + test-data/sam_spec_padded.bam2fq_no_suf.fastq + test-data/sam_spec_padded.bam2fq_singles.fastq + test-data/sam_spec_padded.bam2fq_pairs.fastq + + +Licence (MIT) +============= + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + +NOTE: This is the licence for the Galaxy Wrapper only. +samtools is available and licenced separately.