annotate README.md @ 5:750b705e701f draft default tip

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit ee7bd710f5194337040a592a5c9069bc3486a68f"
author iuc
date Sat, 18 Dec 2021 16:02:08 +0000
parents f5878b9842c7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
1 ## PICRUSt Galaxy Wrapper
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
2
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
3 This page is for anyone interested in installing [PICRUSt](http://picrust.github.io/picrust/) in a [galaxy instance](https://galaxyproject.org/).The below descriptions should clarify the most confusing part of the installation.
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
4
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
5 The most important steps are that you need to go to the Galaxy IUC tool shed and install the 4 wrapper scripts there along with PICRUSt itself. If you install PICRUSt through this interface the precalculated files will not also be installed, you will need to download them separately (see below).
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
6
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
7 Once these scripts are installed sections like the one below should be added to *galaxy/config/shed_tool_data_table_conf.xml* automatically. They will point to different *picrust_precalculated.loc* files; you only need to edit one of them since all of these files will be checked.
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
8
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
9 ```
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
10 <tables>
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
11 <table name="picrust_precalculated" comment_char="#">
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
12 <columns>name, value</columns>
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
13 <file path="tool-data/picrust_precalculated.loc" />
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
14 </table>
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
15 </tables>
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
16 ```
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
17
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
18 You should download the precalculated files from http://kronos.pharmacology.dal.ca/public_files/picrust/picrust_precalculated_v1.1.1/13_5/.
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
19
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
20 Most users only use the below two files (however you can also download the precalculated COG and RFAM abundances):
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
21 ```
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
22 16S_13_5_precalculated.tab.gz
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
23 ko_13_5_precalculated.tab.gz
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
24 ```
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
25
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
26 Once you download these files we just need to point to them in a *picrust_precalculated.loc* file.
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
27
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
28 An example file is shown below. Note that tabs should separate the two columns and that in the below command "16S 13_5" (separated by one space) is one example dbname.
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
29
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
30 ```
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
31 <dbname> <file_base>
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
32 16S 13_5 /path/to/16S_13_5_precalculated.tab.gz
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
33 ko 13_5 /path/to/ko_13_5_precalculated.tab.gz
f5878b9842c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d2e3207994a1a796366a0026396f40f8b88af0c3
iuc
parents:
diff changeset
34 ```