annotate README.md @ 3:9a0f8171a2e2 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit 899e24f2aecad79c80667fb6c938dd4573a98820
author iuc
date Fri, 09 Feb 2024 21:41:10 +0000
parents 61c60e3c8768
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
61c60e3c8768 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
1 ## PICRUSt Galaxy Wrapper
61c60e3c8768 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
2
61c60e3c8768 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.
61c60e3c8768 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
4
61c60e3c8768 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).
61c60e3c8768 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
6
61c60e3c8768 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.
61c60e3c8768 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
8
61c60e3c8768 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
9 ```
61c60e3c8768 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
10 <tables>
61c60e3c8768 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="#">
61c60e3c8768 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>
61c60e3c8768 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" />
61c60e3c8768 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
14 </table>
61c60e3c8768 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
15 </tables>
61c60e3c8768 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
16 ```
61c60e3c8768 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
17
61c60e3c8768 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/.
61c60e3c8768 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
19
61c60e3c8768 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):
61c60e3c8768 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
21 ```
61c60e3c8768 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
61c60e3c8768 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
61c60e3c8768 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
24 ```
61c60e3c8768 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
25
61c60e3c8768 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.
61c60e3c8768 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
27
61c60e3c8768 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.
61c60e3c8768 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
29
61c60e3c8768 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
30 ```
61c60e3c8768 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
31 <dbname> <file_base>
61c60e3c8768 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
61c60e3c8768 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
61c60e3c8768 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picrust commit d4a07fbb603c57131af9cd2223579148a3887baf
iuc
parents:
diff changeset
34 ```