annotate data_manager/data_manager_refgenie_pull.xml @ 1:43d2baff05cd draft

"planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit 9a36112c745f111e68a29cee063e0b36448eb303"
author blankenberglab
date Thu, 30 Sep 2021 14:49:57 +0000
parents aec9bc48cdb7
children b2fa406276e7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
1 <tool id="data_manager_refgenie_pull" name="refgenie asset pulling" version="@VERSION@" tool_type="manage_data" profile="20.05">
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
2 <description>from remote resource</description>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
3 <macros>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
4 <import>macros.xml</import>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
5 </macros>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
6 <requirements>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
7 <requirement type="package" version="@VERSION@">refgenie</requirement>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
8 </requirements>
1
43d2baff05cd "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit 9a36112c745f111e68a29cee063e0b36448eb303"
blankenberglab
parents: 0
diff changeset
9 <version_command>refgenie --version</version_command>
0
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
10 <code file="data_manager_refgenie_pull.py" />
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
11 <environment_variables>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
12 <environment_variable name="API_KEY" inject="api_key" />
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
13 </environment_variables>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
14 <command detect_errors="exit_code"><![CDATA[
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
15 #for $asset in $assets:
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
16 #set ga = str($asset).split('/',2)
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
17 refgenie pull -c '$__app__.config.refgenie_config_file' -g '$ga[1]' '$ga[2]' $force >> '${out_log}' 2>&1
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
18 &&
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
19 #end for
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
20 echo '{}' > '${out_file}'
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
21 #if $api_refresh:
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
22 && python '${__tool_directory__}/data_manager_refgenie_pull.py' -k "\$API_KEY" -u '${__galaxy_url__}' >> '${out_log}'
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
23 #end if
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
24 ]]></command>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
25 <inputs>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
26 <param argument="--assets" name="assets" type="drill_down" display="checkbox" hierarchy="exact" multiple="True" optional="False" label="Select desired asset" dynamic_options="galaxy_code_get_refgenie_assets(__trans__.app.config.refgenie_config_file)" help="string of asset-registry-paths">
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
27 <validator type="regex" message="You must select an asset, not the remote URL or genome.">.+/.+/.+</validator>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
28 </param>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
29 <param argument="--force" name="force" type="boolean" truevalue="--force" falsevalue="" checked="False" label="Force (re-)download" />
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
30 <param argument="--api_refresh" name="api_refresh" type="boolean" truevalue="--api_refresh" falsevalue="" checked="True" label="Refresh Galaxy data tables using API" />
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
31 </inputs>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
32 <outputs>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
33 <data name="out_file" format="data_manager_json"/>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
34 <data name="out_log" format="txt"/>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
35 </outputs>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
36 <tests>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
37 <test>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
38 <param name="assets" value="aHR0cDovL3JlZmdlbm9tZXMuZGF0YWJpby5vcmcvdjIvYXNzZXRz/t7/fasta:default"/>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
39 <param name="force" value="--force"/>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
40 <param name="api_refresh" value=""/>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
41 <output name="out_file">
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
42 <assert_contents>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
43 <has_text text="{}"/>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
44 </assert_contents>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
45 </output>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
46 <output name="out_log">
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
47 <assert_contents>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
48 <has_text text="Download complete"/>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
49 </assert_contents>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
50 </output>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
51 </test>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
52 </tests>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
53 <help><![CDATA[
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
54 **What it does**
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
55
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
56 Fetches a reference genome using refgenie (http://refgenie.databio.org).
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
57
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
58 .. class:: infomark
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
59
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
60 **Notice:** Galaxy data tables will be refreshed using API calls.
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
61
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
62 .. class:: warning
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
63
1
43d2baff05cd "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit 9a36112c745f111e68a29cee063e0b36448eb303"
blankenberglab
parents: 0
diff changeset
64 **You must configure Galaxy to use refgenie, by setting 'refgenie_config_file' in the Galaxy config. This tool uses refgenie config file version 0.4.**
0
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
65 ]]></help>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
66 <citations>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
67 <citation type="doi">10.1093/gigascience/giz149</citation>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
68 <citation type="doi">10.1101/2020.10.09.327114</citation>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
69 </citations>
aec9bc48cdb7 "planemo upload for repository https://github.com/blankenberglab/galaxy-tools-blankenberg/tree/master/data_managers/data_manager_refgenie_pull commit da4cbfcb158b1cf283c5736434fa88b645783306"
blankenberglab
parents:
diff changeset
70 </tool>