annotate README @ 0:f83a08dff6f0 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
author iuc
date Thu, 14 Nov 2019 06:01:29 -0500
parents
children 74385d563652
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
1 Galaxy wrapper for gprofiler2
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
2 =========================
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
3
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
4 g:Profiler is a widely used toolset for finding biological categories enriched in gene lists, conversions between gene identifiers and mappings to their orthologs. Mission of g:Profiler is to provide a reliable service based on up to date high quality data in a convenient manner across many evidence types, identifier spaces and organisms. g:Profiler relies on Ensembl as a primary data source and follows their quarterly release cycle while updating the other data sources simultaneously. g:Profiler provides modern responsive interactive web interface, standardised API, an R package gprofiler2 and libraries. The results are delivered through interactive and configurable interface. Results can be downloaded as publication ready visualisations or delimited text files. g:Profiler supports close to 500 species and strains, including vertebrates, plants, fungi, insects and parasites. By supporting user uploaded custom GMT files, g:Profiler is capable of analysing data from any organism. All past releases are maintained for reproducibility and transparency. g:Profiler is freely available for all users at https://biit.cs.ut.ee/gprofiler.
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
5
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
6 Installation
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
7 ============
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
8
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
9 The recommended installation is by means of the toolshed_.
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
10
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
11 .. _toolshed: http://toolshed.g2.bx.psu.edu/
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
12
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
13 As HTML content is blocked from display, to render optional Plotly output gProfiler GOSt (gprofiler_gost) should be allowed
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
14 at Admin > Tool Management > Manage whitelist.
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
15
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
16
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
17 History
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
18 =======
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
19
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
20 * v0.1.6+galaxy10 - add custom background support, fix dependencies, add messages to stdout
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
21 * v0.1.6+galaxy9 - add notification, fix tests
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
22 * v0.1.6+galaxy8 - improve formatting
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
23 * v0.1.6+galaxy7 - add random tool, update gprofiler2 version, major refactoring, add tests
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
24 * v0.1.6+galaxy6 - fix tools' names
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
25 * v0.1.6+galaxy5 - remove random tool
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
26 * v0.1.6+galaxy4 - modify commands and names to lowercase
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
27 * v0.1.6+galaxy3 - add r-base to requirements, fixes for suite
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
28 * v0.1.6+galaxy2 - remove r-base from requirements, fixes for Linux
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
29 * v0.1.6+galaxy1 - add r-base to requirements
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
30 * v0.1.6+galaxy0 - initial release
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
31
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
32
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
33 Licence (MIT)
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
34 =============
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
35
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
36 Permission is hereby granted, free of charge, to any person obtaining a copy
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
37 of this software and associated documentation files (the "Software"), to deal
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
38 in the Software without restriction, including without limitation the rights
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
39 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
40 copies of the Software, and to permit persons to whom the Software is
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
41 furnished to do so, subject to the following conditions:
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
42
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
43 The above copyright notice and this permission notice shall be included in
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
44 all copies or substantial portions of the Software.
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
45
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
46 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
47 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
48 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
49 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
50 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
51 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
f83a08dff6f0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/gprofiler/ commit ed9b518a6aaf6a5aada47e39c039f6936e41b290"
iuc
parents:
diff changeset
52 THE SOFTWARE.