annotate readme.rst @ 24:33a456e6dadc draft

remove output dir tag, set remove temp to true
author geert-vandeweyer
date Mon, 11 Aug 2014 05:20:55 -0400
parents 032b13f5b087
children 89f22d2a9dfe
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
1 BACKGROUND:
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
2 ClusterFAST is a tool for finding translocation in next generation sequencing data developed by Haley Abel and Eric Duncavage at Washington University in St. Louis, MO. A manuscript detailing the use of ClusterFAST ican be found at: http://www.ncbi.nlm.nih.gov/pubmed/?term=24813172. For questions or comments please email eduncavage@path.wustl.edu
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
3
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
4 ClusterFAST is a pipeline for highly specific detection of translocations from high-coverage targeted capture sequence data. It detects translocation breakpoints with single base accuracy and provides assembled contigs for PCR validation. ClustFAST is implemented in Java for improved interoperability and can be run from the command line via a perl script. ClusterFAST is meant for translocation detection from targeted regions and requires a picard-style interval file containing the targets (e.g., ALK_MLL.txt). Numerous output files are created during the workflow (see below) to allow for error checking. The current version of ClusterFAST uses velvet to assemble contigs during the final step, however other assemblers can be substituted.
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
5
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
6 GALAXY WRAPPER:
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
7 This galaxy wrapper was created by Geert Vandeweyer. It represents a static snapshot of ClusterFast version 0611 (received from the authors on 2014-07-24). For questions regarding its functionality, contact me by geert.vandeweyer@uantwerpen.be
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
8
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
9 LICENSE AND DISCLAIMER:
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
10 ClusterFAST is protected by copyright, is distributed under the GNU GPL public license, and may be used freely for research purposes. The use of ClusterFAST for the purpose of financial profit or the inclusion/distribution with for-profit software not covered by GNU public license is prohibited. Please email eduncavage@path.wustl.edu for information on commercial license. The performance of ClusterFAST will vary depending on many sequencing parameters and must be validated by individual labratories.
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
11
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
12 INSTALLATION:
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
13 Galaxy should be able to install all depedencies automatically. These include
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
14 - samtools
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
15 - blat-server
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
16 - velvet
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
17 - novoalign
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
18
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
19 After installation, you need to update several environment settings for the dependencies to work correctly.
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
20
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
21 - NOVOALIGN path: (novoalign binaries are NOT automatically installed, see package_novoalign for details ) : <tool_dependency_dir>/environment_settings/NOVOALIGN_PATH/geert-vandeweyer/package_novoalign/<hash_string>/env.sh
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
22 - index files (clusterfast.loc holds info on 2bit/fasta/novoalign references) : <path>/galaxy-dist/tool-data/<toolshed>/repos/geert-vandeweyer/clusterfast/<hash>/clusterfast.loc. Read comments for the exact syntax.
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
23 - number of velvet threads : <tool_dependency_dir>/environment_settings/OMP_THREAD_LIMIT/geert-vandeweyer/package_velvet/<hash_string>/env.sh
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
24
032b13f5b087 Uploaded
geert-vandeweyer
parents:
diff changeset
25