Mercurial > repos > immuneml > immuneml_tools

comparison immuneml_yaml.xml @ 0:629e7e403e19 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload commit 2fed2858d4044a3897a93a5604223d1d183ceac0-dirty"
author immuneml
date Thu, 01 Jul 2021 11:36:43 +0000
parents
children ed3932e6d616
comparison
equal deleted inserted replaced
-1:000000000000 0:629e7e403e19
1 <tool id="immune_ml" name="Run immuneML with any YAML specification" version="@VERSION@.0">
2 <description></description>
3 <macros>
4 <import>prod_macros.xml</import>
5 </macros>
6 <expand macro="requirements" />
7 <command><![CDATA[
8
9 #if $iml_input
10 cp -r ${iml_input.extra_files_path}/result/* . &&
11 (mv repertoires/* . &>/dev/null || :) &&
12 rm -rf repertoires &&
13 #end if
14
15 #set $input_orig_names = []
16 #if $data_input
17 #for $input in $data_input
18 #set input_orig_names += [str($input.element_identifier)]
19 ([ -e ./"$input.element_identifier" ] && echo "File '$input.element_identifier' already exists in the input folder, skipping." || ln -s $input "$input.element_identifier") &&
20 #end for#
21 #end if
22
23 cp "$yaml_input" yaml_copy &&
24 immune-ml ./yaml_copy ${html_outfile.files_path} --tool GalaxyYamlTool &&
25 mv ${html_outfile.files_path}/index.html ${html_outfile} &&
26 mv ${html_outfile.files_path}/immuneML_output.zip $archive
27
28 ]]>
29 </command>
30 <inputs>
31 <param name="yaml_input" type="data" format="txt" label="YAML specification" multiple="false"/>
32 <param name="data_input" type="data" multiple="true" label="Additional files" optional="true" help="This field should include individual repertoire files, metadata files, receptor data and others."/>
33 <param name="iml_input" type="data" format="iml_dataset" label="ImmuneML dataset" optional="true" help="This field accepts ImmuneML datasets, as created by the Create Dataset tool."/>
34 </inputs>
35 <outputs>
36 <data format="zip" name="archive" label="Archive: immuneML Analysis"/>
37 <data format="html" name="html_outfile" label="Summary: immuneML analysis"/>
38 </outputs>
39
40
41 <help><![CDATA[
42
43
44 This Galaxy tool can be used to run any possible YAML-based immuneML analysis in Galaxy.
45
46 It is typically recommended to use the analysis-specific Galaxy tools for
47 `creating datasets <https://galaxy.immuneml.uio.no/root?tool_id=immune_ml_dataset>`_,
48 `simulating synthetic data <https://galaxy.immuneml.uio.no/root?tool_id=immuneml_simulate_dataset>`_,
49 `implanting synthetic immune signals <https://galaxy.immuneml.uio.no/root?tool_id=immuneml_simulation>`_ or
50 `training <https://galaxy.immuneml.uio.no/root?tool_id=immuneml_train_ml_model>`_ and
51 `applying <https://galaxy.immuneml.uio.no/root?tool_id=immuneml_apply_ml_model>`_ ML models instead of this tool.
52 These other tools are able to export the relevant output files to Galaxy history elements.
53
54 However, when you want to run the `ExploratoryAnalysis <https://docs.immuneml.uio.no/specification.html#exploratoryanalysis>`_ instruction,
55 or other analyses that do not have a corresponding Galaxy tool, this generic tool can be used.
56
57 For the exhaustive documentation of this tool and an example YAML specification for exploratory analysis, see the tutorial `How to run any AIRR ML analysis in Galaxy <https://docs.immuneml.uio.no/galaxy/galaxy_general_yaml.html>`_.
58
59
60 **Tool output**
61
62 This Galaxy tool will produce the following history elements:
63
64 - Summary: immuneML analysis: a HTML page that allows you to browse through all results.
65
66 - ImmuneML Analysis Archive: a .zip file containing the complete output folder as it was produced by immuneML. This folder
67 contains the output of the instruction that was used, including all raw data files.
68 Furthermore, the folder contains the complete YAML specification file for the immuneML run, the HTML output and a log file.
69
70
71 ]]>
72 </help>
73
74 </tool>