annotate README @ 14:d9c3016f7283 draft default tip

planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 192779247c3385704ebd98a2cc47a210fb1f4d0c
author galaxyp
date Thu, 07 Sep 2023 18:51:23 +0000
parents 844fa988236b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13
844fa988236b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 468bd31b8858adbba2854f118e4cbe31f4cd68cb
galaxyp
parents:
diff changeset
1 This folder contains three tools:
844fa988236b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 468bd31b8858adbba2854f118e4cbe31f4cd68cb
galaxyp
parents:
diff changeset
2
844fa988236b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 468bd31b8858adbba2854f118e4cbe31f4cd68cb
galaxyp
parents:
diff changeset
3 1. eggnogg_mapper: which runs the search and annotation phase in a single tool
844fa988236b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 468bd31b8858adbba2854f118e4cbe31f4cd68cb
galaxyp
parents:
diff changeset
4 2. eggnogg_mapper_search: which implements the search phase
844fa988236b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 468bd31b8858adbba2854f118e4cbe31f4cd68cb
galaxyp
parents:
diff changeset
5 3. eggnogg_mapper_annotate: which implements the annotation phase
844fa988236b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 468bd31b8858adbba2854f118e4cbe31f4cd68cb
galaxyp
parents:
diff changeset
6
844fa988236b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 468bd31b8858adbba2854f118e4cbe31f4cd68cb
galaxyp
parents:
diff changeset
7 While the search phase of eggnog_mapper is very CPU intense and is efficient
844fa988236b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 468bd31b8858adbba2854f118e4cbe31f4cd68cb
galaxyp
parents:
diff changeset
8 also for a larger number of threads, the annotation phase is very IO intensive
844fa988236b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 468bd31b8858adbba2854f118e4cbe31f4cd68cb
galaxyp
parents:
diff changeset
9 and can be very inefficient (depending on the configuration, e.g. if the
844fa988236b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 468bd31b8858adbba2854f118e4cbe31f4cd68cb
galaxyp
parents:
diff changeset
10 reference data is located on a slow partition).
844fa988236b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 468bd31b8858adbba2854f118e4cbe31f4cd68cb
galaxyp
parents:
diff changeset
11
844fa988236b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 468bd31b8858adbba2854f118e4cbe31f4cd68cb
galaxyp
parents:
diff changeset
12 While for most applications eggnogg_mapper will be sufficient to separate the
844fa988236b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 468bd31b8858adbba2854f118e4cbe31f4cd68cb
galaxyp
parents:
diff changeset
13 two phases can be more efficient:
844fa988236b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 468bd31b8858adbba2854f118e4cbe31f4cd68cb
galaxyp
parents:
diff changeset
14
844fa988236b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 468bd31b8858adbba2854f118e4cbe31f4cd68cb
galaxyp
parents:
diff changeset
15 - sending eggnogg_mapper_search to a destination using many threads
844fa988236b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 468bd31b8858adbba2854f118e4cbe31f4cd68cb
galaxyp
parents:
diff changeset
16 - and eggnogg_mapper_annotate to a destination using a small number of threads
844fa988236b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 468bd31b8858adbba2854f118e4cbe31f4cd68cb
galaxyp
parents:
diff changeset
17
844fa988236b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 468bd31b8858adbba2854f118e4cbe31f4cd68cb
galaxyp
parents:
diff changeset
18 Admins can choose to set the environment variable ``EGGNOG_DBMEM=--dbmem``
844fa988236b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 468bd31b8858adbba2854f118e4cbe31f4cd68cb
galaxyp
parents:
diff changeset
19 which will copy the complete EggNOG annotation DB into memory which is usually
844fa988236b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/eggnog_mapper/eggnog_mapper commit 468bd31b8858adbba2854f118e4cbe31f4cd68cb
galaxyp
parents:
diff changeset
20 much faster than using multiple cores (but needs approx. 37GB of RAM).