Mercurial > repos > immuneml > immuneml_tools

annotate README.rst @ 5:48569213d91c draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload commit 49b58953ab7eec02a6917044be672ad9a65eab5c-dirty"
author immuneml
date Fri, 02 Jul 2021 11:04:53 +0000
parents ed3932e6d616
children 2d3dd9ff7e84
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
48569213d91c "planemo upload commit 49b58953ab7eec02a6917044be672ad9a65eab5c-dirty"
immuneml
parents: 3
diff changeset
1 Dependencies
1
08042588bd02 "planemo upload commit 2fed2858d4044a3897a93a5604223d1d183ceac0-dirty"
immuneml
parents:
diff changeset
2 ============
5
48569213d91c "planemo upload commit 49b58953ab7eec02a6917044be672ad9a65eab5c-dirty"
immuneml
parents: 3
diff changeset
3 The tools rely on immuneML version 2.0.1 or newer.
48569213d91c "planemo upload commit 49b58953ab7eec02a6917044be672ad9a65eab5c-dirty"
immuneml
parents: 3
diff changeset
4
48569213d91c "planemo upload commit 49b58953ab7eec02a6917044be672ad9a65eab5c-dirty"
immuneml
parents: 3
diff changeset
5 Installation: datatype
48569213d91c "planemo upload commit 49b58953ab7eec02a6917044be672ad9a65eab5c-dirty"
immuneml
parents: 3
diff changeset
6 ======================
3
ed3932e6d616 "planemo upload commit 2fed2858d4044a3897a93a5604223d1d183ceac0-dirty"
immuneml
parents: 2
diff changeset
7 You will need to define a new datatype ``immuneml_receptors``, which is done as follows:
1
08042588bd02 "planemo upload commit 2fed2858d4044a3897a93a5604223d1d183ceac0-dirty"
immuneml
parents:
diff changeset
8
08042588bd02 "planemo upload commit 2fed2858d4044a3897a93a5604223d1d183ceac0-dirty"
immuneml
parents:
diff changeset
9 1. In your ``galaxy.yml`` look up the name of your ``datatypes_config_file``. If the name is not yet defined, set
08042588bd02 "planemo upload commit 2fed2858d4044a3897a93a5604223d1d183ceac0-dirty"
immuneml
parents:
diff changeset
10
08042588bd02 "planemo upload commit 2fed2858d4044a3897a93a5604223d1d183ceac0-dirty"
immuneml
parents:
diff changeset
11 ``datatypes_config_file: datatypes_conf.xml``
08042588bd02 "planemo upload commit 2fed2858d4044a3897a93a5604223d1d183ceac0-dirty"
immuneml
parents:
diff changeset
12
08042588bd02 "planemo upload commit 2fed2858d4044a3897a93a5604223d1d183ceac0-dirty"
immuneml
parents:
diff changeset
13 2. Make ``datatypes_conf.xml`` by copying ``datatypes_conf.xml.sample`` unless a ``datatypes_config_file`` was already defined.
08042588bd02 "planemo upload commit 2fed2858d4044a3897a93a5604223d1d183ceac0-dirty"
immuneml
parents:
diff changeset
14 3. Add the following line to your ``datatypes_config_file``:
08042588bd02 "planemo upload commit 2fed2858d4044a3897a93a5604223d1d183ceac0-dirty"
immuneml
parents:
diff changeset
15
3
ed3932e6d616 "planemo upload commit 2fed2858d4044a3897a93a5604223d1d183ceac0-dirty"
immuneml
parents: 2
diff changeset
16 ``<datatype extension="immuneml_receptors" type="galaxy.datatypes.text:Html" subclass="True"/>``
1
08042588bd02 "planemo upload commit 2fed2858d4044a3897a93a5604223d1d183ceac0-dirty"
immuneml
parents:
diff changeset
17 The line has to be inside ``<registration>`` along with the other datatypes.
08042588bd02 "planemo upload commit 2fed2858d4044a3897a93a5604223d1d183ceac0-dirty"
immuneml
parents:
diff changeset
18
5
48569213d91c "planemo upload commit 49b58953ab7eec02a6917044be672ad9a65eab5c-dirty"
immuneml
parents: 3
diff changeset
19 Installation: The immuneML package
48569213d91c "planemo upload commit 49b58953ab7eec02a6917044be672ad9a65eab5c-dirty"
immuneml
parents: 3
diff changeset
20 ==================================
48569213d91c "planemo upload commit 49b58953ab7eec02a6917044be672ad9a65eab5c-dirty"
immuneml
parents: 3
diff changeset
21 Conda installation of immuneML typically takes several minutes. There is general information about Galaxy's dependency resolution here: https://docs.galaxyproject.org/en/release_20.05/admin/conda_faq.html