changeset 1:08042588bd02 draft

"planemo upload commit 2fed2858d4044a3897a93a5604223d1d183ceac0-dirty"
author immuneml
date Thu, 01 Jul 2021 13:37:27 +0000
parents 629e7e403e19
children 9bf78cb6b91d
files README.rst
diffstat 1 files changed, 20 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst	Thu Jul 01 13:37:27 2021 +0000
@@ -0,0 +1,20 @@
+Galaxy tool wrappers for immuneML.
+==================================
+
+Installation
+============
+You will need to define a new datatype, which is done as follows:
+
+1. In your ``galaxy.yml`` look up the name of your ``datatypes_config_file``. If the name is not yet defined, set
+
+``datatypes_config_file: datatypes_conf.xml``
+
+2. Make ``datatypes_conf.xml`` by copying ``datatypes_conf.xml.sample`` unless a ``datatypes_config_file`` was already defined.
+3. Add the following line to your ``datatypes_config_file``:
+
+``<datatype extension="iml_dataset" type="galaxy.datatypes.text:Html" subclass="True"/>``
+The line has to be inside ``<registration>`` along with the other datatypes.
+
+The immuneML conda package
+==========================
+Galaxy will need to install the immuneML conda package. This conda installation typically takes several minutes.