diff README @ 0:51916b7025ba 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:00:39 -0500
parents
children bf39cdd007f5
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Thu Nov 14 06:00:39 2019 -0500
@@ -0,0 +1,52 @@
+Galaxy wrapper for gprofiler2
+=========================
+
+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.
+
+Installation
+============
+
+The recommended installation is by means of the toolshed_.
+
+.. _toolshed: http://toolshed.g2.bx.psu.edu/
+
+As HTML content is blocked from display, to render optional Plotly output gProfiler GOSt (gprofiler_gost) should be allowed
+at Admin > Tool Management > Manage whitelist.
+
+
+History
+=======
+
+* v0.1.6+galaxy10 - add custom background support, fix dependencies, add messages to stdout
+* v0.1.6+galaxy9 - add notification, fix tests
+* v0.1.6+galaxy8 - improve formatting
+* v0.1.6+galaxy7 - add random tool, update gprofiler2 version, major refactoring, add tests
+* v0.1.6+galaxy6 - fix tools' names
+* v0.1.6+galaxy5 - remove random tool
+* v0.1.6+galaxy4 - modify commands and names to lowercase
+* v0.1.6+galaxy3 - add r-base to requirements, fixes for suite
+* v0.1.6+galaxy2 - remove r-base from requirements, fixes for Linux
+* v0.1.6+galaxy1 - add r-base to requirements
+* v0.1.6+galaxy0 - initial release
+
+
+Licence (MIT)
+=============
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.