annotate README.md @ 2:025049cb66eb 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:45 +0000
parents a3b0b2a42460
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
1 ## PICRUSt Galaxy Wrapper
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
2
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
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.
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
4
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
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).
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
6
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
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.
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
8
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
9 ```
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
10 <tables>
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
11 <table name="picrust_precalculated" comment_char="#">
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
12 <columns>name, value</columns>
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
13 <file path="tool-data/picrust_precalculated.loc" />
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
14 </table>
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
15 </tables>
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
16 ```
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
17
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
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/.
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
19
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
20 Most users only use the below two files (however you can also download the precalculated COG and RFAM abundances):
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
21 ```
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
22 16S_13_5_precalculated.tab.gz
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
23 ko_13_5_precalculated.tab.gz
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
24 ```
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
25
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
26 Once you download these files we just need to point to them in a *picrust_precalculated.loc* file.
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
27
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
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.
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
29
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
30 ```
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
31 <dbname> <file_base>
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
32 16S 13_5 /path/to/16S_13_5_precalculated.tab.gz
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
33 ko 13_5 /path/to/ko_13_5_precalculated.tab.gz
a3b0b2a42460 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
34 ```