Mercurial > repos > pjbriggs > amplicon_analysis_pipeline
annotate README.rst @ 52:6c15d2223e46 draft default tip
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 7be61b7ed35ca3deaad68d2eae384c8cd365bcb8
author | pjbriggs |
---|---|
date | Fri, 20 Dec 2019 11:59:21 +0000 |
parents | 098ad1dd7760 |
children |
rev | line source |
---|---|
42
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
1 Amplicon_analysis-galaxy |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
2 ======================== |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
3 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
4 A Galaxy tool wrapper to Mauro Tutino's ``Amplicon_analysis`` pipeline |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
5 script at https://github.com/MTutino/Amplicon_analysis |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
6 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
7 The pipeline can analyse paired-end 16S rRNA data from Illumina Miseq |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
8 (Casava >= 1.8) and performs the following operations: |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
9 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
10 * QC and clean up of input data |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
11 * Removal of singletons and chimeras and building of OTU table |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
12 and phylogenetic tree |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
13 * Beta and alpha diversity of analysis |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
14 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
15 Usage documentation |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
16 =================== |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
17 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
18 Usage of the tool (including required inputs) is documented within |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
19 the ``help`` section of the tool XML. |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
20 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
21 Installing the tool in a Galaxy instance |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
22 ======================================== |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
23 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
24 The following sections describe how to install the tool files, |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
25 dependencies and reference data, and how to configure the Galaxy |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
26 instance to detect the dependencies and reference data correctly |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
27 at run time. |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
28 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
29 1. Install the tool from the toolshed |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
30 ------------------------------------- |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
31 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
32 The core tool is hosted on the Galaxy toolshed, so it can be installed |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
33 directly from there (this is the recommended route): |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
34 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
35 * https://toolshed.g2.bx.psu.edu/view/pjbriggs/amplicon_analysis_pipeline/ |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
36 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
37 Alternatively it can be installed manually; in this case there are two |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
38 files to install: |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
39 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
40 * ``amplicon_analysis_pipeline.xml`` (the Galaxy tool definition) |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
41 * ``amplicon_analysis_pipeline.py`` (the Python wrapper script) |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
42 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
43 Put these in a directory that is visible to Galaxy (e.g. a |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
44 ``tools/Amplicon_analysis/`` folder), and modify the ``tools_conf.xml`` |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
45 file to tell Galaxy to offer the tool by adding the line e.g.:: |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
46 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
47 <tool file="Amplicon_analysis/amplicon_analysis_pipeline.xml" /> |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
48 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
49 2. Install the reference data |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
50 ----------------------------- |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
51 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
52 The script ``References.sh`` from the pipeline package at |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
53 https://github.com/MTutino/Amplicon_analysis can be run to install |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
54 the reference data, for example:: |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
55 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
56 cd /path/to/pipeline/data |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
57 wget https://github.com/MTutino/Amplicon_analysis/raw/master/References.sh |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
58 /bin/bash ./References.sh |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
59 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
60 will install the data in ``/path/to/pipeline/data``. |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
61 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
62 **NB** The final amount of data downloaded and uncompressed will be |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
63 around 9GB. |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
64 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
65 3. Configure reference data location in Galaxy |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
66 ---------------------------------------------- |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
67 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
68 The final step is to make your Galaxy installation aware of the |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
69 location of the reference data, so it can locate them both when the |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
70 tool is run. |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
71 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
72 The tool locates the reference data via an environment variable called |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
73 ``AMPLICON_ANALYSIS_REF_DATA_PATH``, which needs to set to the parent |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
74 directory where the reference data has been installed. |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
75 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
76 There are various ways to do this, depending on how your Galaxy |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
77 installation is configured: |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
78 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
79 * **For local instances:** add a line to set it in the |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
80 ``config/local_env.sh`` file of your Galaxy installation (you |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
81 may need to create a new empty file first), e.g.:: |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
82 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
83 export AMPLICON_ANALYSIS_REF_DATA_PATH=/path/to/pipeline/data |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
84 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
85 * **For production instances:** set the value in the ``job_conf.xml`` |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
86 configuration file, e.g.:: |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
87 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
88 <destination id="amplicon_analysis"> |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
89 <env id="AMPLICON_ANALYSIS_REF_DATA_PATH">/path/to/pipeline/data</env> |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
90 </destination> |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
91 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
92 and then specify that the pipeline tool uses this destination:: |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
93 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
94 <tool id="amplicon_analysis_pipeline" destination="amplicon_analysis"/> |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
95 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
96 (For more about job destinations see the Galaxy documentation at |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
97 https://docs.galaxyproject.org/en/master/admin/jobs.html#job-destinations) |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
98 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
99 4. Enable rendering of HTML outputs from pipeline |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
100 ------------------------------------------------- |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
101 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
102 To ensure that HTML outputs are displayed correctly in Galaxy |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
103 (for example the Vsearch OTU table heatmaps), Galaxy needs to be |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
104 configured not to sanitize the outputs from the ``Amplicon_analysis`` |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
105 tool. |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
106 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
107 Either: |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
108 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
109 * **For local instances:** set ``sanitize_all_html = False`` in |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
110 ``config/galaxy.ini`` (nb don't do this on production servers or |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
111 public instances!); or |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
112 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
113 * **For production instances:** add the ``Amplicon_analysis`` tool |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
114 to the display whitelist in the Galaxy instance: |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
115 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
116 - Set ``sanitize_whitelist_file = config/whitelist.txt`` in |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
117 ``config/galaxy.ini`` and restart Galaxy; |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
118 - Go to ``Admin>Manage Display Whitelist``, check the box for |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
119 ``Amplicon_analysis`` (hint: use your browser's 'find-in-page' |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
120 search function to help locate it) and click on |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
121 ``Submit new whitelist`` to update the settings. |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
122 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
123 Additional details |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
124 ================== |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
125 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
126 Some other things to be aware of: |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
127 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
128 * Note that using the Silva database requires a minimum of 18Gb RAM |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
129 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
130 Known problems |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
131 ============== |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
132 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
133 * Only the ``VSEARCH`` pipeline in Mauro's script is currently |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
134 available via the Galaxy tool; the ``USEARCH`` and ``QIIME`` |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
135 pipelines have yet to be implemented. |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
136 * The images in the tool help section are not visible if the |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
137 tool has been installed locally, or if it has been installed in |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
138 a Galaxy instance which is served from a subdirectory. |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
139 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
140 These are both problems with Galaxy and not the tool, see |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
141 https://github.com/galaxyproject/galaxy/issues/4490 and |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
142 https://github.com/galaxyproject/galaxy/issues/1676 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
143 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
144 Appendix: installing the dependencies manually |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
145 ============================================== |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
146 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
147 If the tool is installed from the Galaxy toolshed (recommended) then |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
148 the dependencies should be installed automatically and this step can |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
149 be skipped. |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
150 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
151 Otherwise the ``install_amplicon_analysis_deps.sh`` script can be used |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
152 to fetch and install the dependencies locally, for example:: |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
153 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
154 install_amplicon_analysis.sh /path/to/local_tool_dependencies |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
155 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
156 (This is the same script as is used to install dependencies from the |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
157 toolshed.) This can take some time to complete, and when completed will |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
158 have created a directory called ``Amplicon_analysis-1.2.3`` containing |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
159 the dependencies under the specified top level directory. |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
160 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
161 **NB** The installed dependencies will occupy around 2.6G of disk |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
162 space. |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
163 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
164 You will need to make sure that the ``bin`` subdirectory of this |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
165 directory is on Galaxy's ``PATH`` at runtime, for the tool to be able |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
166 to access the dependencies - for example by adding a line to the |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
167 ``local_env.sh`` file like:: |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
168 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
169 export PATH=/path/to/local_tool_dependencies/Amplicon_analysis-1.2.3/bin:$PATH |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
170 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
171 History |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
172 ======= |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
173 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
174 ========== ====================================================================== |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
175 Version Changes |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
176 ---------- ---------------------------------------------------------------------- |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
177 1.3.5.0 Updated to Amplicon_Analysis_Pipeline version 1.3.5. |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
178 1.2.3.0 Updated to Amplicon_Analysis_Pipeline version 1.2.3; install |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
179 dependencies via tool_dependencies.xml. |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
180 1.2.2.0 Updated to Amplicon_Analysis_Pipeline version 1.2.2 (removes |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
181 jackknifed analysis which is not captured by Galaxy tool) |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
182 1.2.1.0 Updated to Amplicon_Analysis_Pipeline version 1.2.1 (adds |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
183 option to use the Human Oral Microbiome Database v15.1, and |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
184 updates SILVA database to v123) |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
185 1.1.0 First official version on Galaxy toolshed. |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
186 1.0.6 Expand inline documentation to provide detailed usage guidance. |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
187 1.0.5 Updates including: |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
188 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
189 - Capture read counts from quality control as new output dataset |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
190 - Capture FastQC per-base quality boxplots for each sample as |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
191 new output dataset |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
192 - Add support for -l option (sliding window length for trimming) |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
193 - Default for -L set to "200" |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
194 1.0.4 Various updates: |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
195 |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
196 - Additional outputs are captured when a "Categories" file is |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
197 supplied (alpha diversity rarefaction curves and boxplots) |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
198 - Sample names derived from Fastqs in a collection of pairs |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
199 are trimmed to SAMPLE_S* (for Illumina-style Fastq filenames) |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
200 - Input Fastqs can now be of more general ``fastq`` type |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
201 - Log file outputs are captured in new output dataset |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
202 - User can specify a "title" for the job which is copied into |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
203 the dataset names (to distinguish outputs from different runs) |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
204 - Improved detection and reporting of problems with input |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
205 Metatable |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
206 1.0.3 Take the sample names from the collection dataset names when |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
207 using collection as input (this is now the default input mode); |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
208 collect additional output dataset; disable ``usearch``-based |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
209 pipelines (i.e. ``UPARSE`` and ``QIIME``). |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
210 1.0.2 Enable support for FASTQs supplied via dataset collections and |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
211 fix some broken output datasets. |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
212 1.0.1 Initial version |
098ad1dd7760
planemo upload for repository https://github.com/pjbriggs/Amplicon_analysis-galaxy commit 10be6f00106e853a6720e4052871d9d84e027137
pjbriggs
parents:
diff
changeset
|
213 ========== ====================================================================== |