annotate readme.txt @ 1:12c3ae8c835a draft default tip

Uploaded
author lparsons
date Wed, 24 Jul 2013 13:16:43 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
12c3ae8c835a Uploaded
lparsons
parents:
diff changeset
1 This tool uses the sambamba view command to filter BAM/SAM on flags, fields, tags, and region. Input is SAM or BAM file.
12c3ae8c835a Uploaded
lparsons
parents:
diff changeset
2
12c3ae8c835a Uploaded
lparsons
parents:
diff changeset
3 There are a three options for installation of sambamba:
12c3ae8c835a Uploaded
lparsons
parents:
diff changeset
4
12c3ae8c835a Uploaded
lparsons
parents:
diff changeset
5 1) Automated toolshed installation. This requires that a D2 compiler (dmd >= 2.063) is installed. The automated installation will attempt to use the dmd compiler and thus **will not be optimized**.
12c3ae8c835a Uploaded
lparsons
parents:
diff changeset
6
12c3ae8c835a Uploaded
lparsons
parents:
diff changeset
7 2) Manual compilation. For performance reasons, the sambamba developers recommend you use either GDC or LDC as they use GCC and LLVM backends and do a much better job at optimization. You should then use the sambamba-ldmd2-64 make target. See https://github.com/lomereiter/sambamba/wiki/Command-line-tools for more information.
12c3ae8c835a Uploaded
lparsons
parents:
diff changeset
8
12c3ae8c835a Uploaded
lparsons
parents:
diff changeset
9 3) Precompiled binary (recommended). You may wish to simply use a precompiled binary of sambamba available at https://www.dropbox.com/sh/v05fsb5aarob3xe/iUHgyud31a/sambamba.
12c3ae8c835a Uploaded
lparsons
parents:
diff changeset
10
12c3ae8c835a Uploaded
lparsons
parents:
diff changeset
11 If you choose option 2 or 3, sambamba may be installed as a "Managed Dependency" in Galaxy's "tool_dependency_dir". See http://wiki.galaxyproject.org/Admin/Config/Tool%20Dependencies.
12c3ae8c835a Uploaded
lparsons
parents:
diff changeset
12
12c3ae8c835a Uploaded
lparsons
parents:
diff changeset
13 The development repository for the galaxy wrapper is at: https://bitbucket.org/lance_parsons/sambamba_filter_galaxy_wrapper
12c3ae8c835a Uploaded
lparsons
parents:
diff changeset
14 The sambamba development repository is at: https://github.com/lomereiter/sambamba.