annotate cb_ivr.xml @ 2:bcbad4f83dec draft default tip

planemo upload for repository https://github.com/Marie59/champ_blocs commit 075fd90d1a39ae7912b48549e5537971635b9620
author ecology
date Sat, 18 Mar 2023 16:49:19 +0000
parents b67730406f1b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
bcbad4f83dec planemo upload for repository https://github.com/Marie59/champ_blocs commit 075fd90d1a39ae7912b48549e5537971635b9620
ecology
parents: 1
diff changeset
1 <tool id="cb_ivr" name="IVR" version="@VERSION@" profile="20.01">
0
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
2 <description>indicator</description>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
3 <macros>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
4 <import>macro.xml</import>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
5 </macros>
2
bcbad4f83dec planemo upload for repository https://github.com/Marie59/champ_blocs commit 075fd90d1a39ae7912b48549e5537971635b9620
ecology
parents: 1
diff changeset
6 <requirements>
bcbad4f83dec planemo upload for repository https://github.com/Marie59/champ_blocs commit 075fd90d1a39ae7912b48549e5537971635b9620
ecology
parents: 1
diff changeset
7 <requirement type="package" version="1.0.10">r-dplyr</requirement>
bcbad4f83dec planemo upload for repository https://github.com/Marie59/champ_blocs commit 075fd90d1a39ae7912b48549e5537971635b9620
ecology
parents: 1
diff changeset
8 <requirement type="package" version="1.2.1">r-tidyr</requirement>
bcbad4f83dec planemo upload for repository https://github.com/Marie59/champ_blocs commit 075fd90d1a39ae7912b48549e5537971635b9620
ecology
parents: 1
diff changeset
9 <requirement type="package" version="1.4.1">r-stringr</requirement>
bcbad4f83dec planemo upload for repository https://github.com/Marie59/champ_blocs commit 075fd90d1a39ae7912b48549e5537971635b9620
ecology
parents: 1
diff changeset
10 <requirement type="package" version="3.1.8">r-tibble</requirement>
bcbad4f83dec planemo upload for repository https://github.com/Marie59/champ_blocs commit 075fd90d1a39ae7912b48549e5537971635b9620
ecology
parents: 1
diff changeset
11 <requirement type="package" version="1.40">r-knitr</requirement>
bcbad4f83dec planemo upload for repository https://github.com/Marie59/champ_blocs commit 075fd90d1a39ae7912b48549e5537971635b9620
ecology
parents: 1
diff changeset
12 <requirement type="package" version="0.6_8">r-gmp</requirement>
bcbad4f83dec planemo upload for repository https://github.com/Marie59/champ_blocs commit 075fd90d1a39ae7912b48549e5537971635b9620
ecology
parents: 1
diff changeset
13 <requirement type="package" version="2.0.3">r-magrittr</requirement>
bcbad4f83dec planemo upload for repository https://github.com/Marie59/champ_blocs commit 075fd90d1a39ae7912b48549e5537971635b9620
ecology
parents: 1
diff changeset
14 <requirement type="package" version="2.18">r-rmarkdown</requirement>
0
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
15 <requirement type="package" version="0.2.4">r-officedown</requirement>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
16 <requirement type="package" version="1.3.2">r-tidyverse</requirement>
2
bcbad4f83dec planemo upload for repository https://github.com/Marie59/champ_blocs commit 075fd90d1a39ae7912b48549e5537971635b9620
ecology
parents: 1
diff changeset
17 <requirement type="package" version="0.5.1">r-officer</requirement>
1
b67730406f1b planemo upload for repository https://github.com/Marie59/champ_blocs commit 0d86db7d42b608c386a54500064f5f9c9d7019a4
ecology
parents: 0
diff changeset
18 <requirement type="package" version="0.8.3">r-flextable</requirement>
2
bcbad4f83dec planemo upload for repository https://github.com/Marie59/champ_blocs commit 075fd90d1a39ae7912b48549e5537971635b9620
ecology
parents: 1
diff changeset
19 <requirement type="package" version="3.4.0">r-ggplot2</requirement>
bcbad4f83dec planemo upload for repository https://github.com/Marie59/champ_blocs commit 075fd90d1a39ae7912b48549e5537971635b9620
ecology
parents: 1
diff changeset
20 </requirements>
0
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
21 <required_files>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
22 <include type="literal" path="test-data/champbloc_ivr.csv"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
23 <include type="literal" path="test-data/ficheterrain.csv"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
24 <include type="literal" path="CB_ivr.tif"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
25 <include type="literal" path="logo_merged.png"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
26 <include type="literal" path="cb_ivr_site_report_col_scale_loop.Rmd"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
27 <include type="literal" path="loop_col_scale.r"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
28 <include type="literal" path="cb_ivr.r"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
29 </required_files>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
30 <command detect_errors="exit_code"><![CDATA[
2
bcbad4f83dec planemo upload for repository https://github.com/Marie59/champ_blocs commit 075fd90d1a39ae7912b48549e5537971635b9620
ecology
parents: 1
diff changeset
31 cp '$__tool_directory__/cb_ivr_site_report_col_scale_loop.Rmd' ./cb_ivr_site_report_col_scale_loop.Rmd &&
0
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
32 Rscript
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
33 '$__tool_directory__/cb_ivr.r'
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
34 '$fiche_val'
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
35 '$input_data'
2
bcbad4f83dec planemo upload for repository https://github.com/Marie59/champ_blocs commit 075fd90d1a39ae7912b48549e5537971635b9620
ecology
parents: 1
diff changeset
36 ./cb_ivr_site_report_col_scale_loop.Rmd
0
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
37 '$__tool_directory__/loop_col_scale.r'
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
38 '$output_ivr'
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
39 '$plots'
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
40 '$output_report'
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
41 ]]>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
42 </command>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
43 <inputs>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
44 <expand macro="cb_input"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
45 <param name="input_data" type="data" format="data" label="Input champbloc_ivr.csv"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
46 </inputs>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
47 <outputs>
1
b67730406f1b planemo upload for repository https://github.com/Marie59/champ_blocs commit 0d86db7d42b608c386a54500064f5f9c9d7019a4
ecology
parents: 0
diff changeset
48 <data name="output_ivr" from_work_dir="ivr_val_qu.RDS" format="rdata" label="IVR Rdata"/>
0
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
49 <collection type="list" name="plots" label="IVR plot">
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
50 <discover_datasets pattern="(?P&lt;designation&gt;.+)\.png" visible="false" format="png"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
51 </collection>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
52 <collection type="list" name="output_report" label="Reports">
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
53 <discover_datasets pattern="(?P&lt;designation&gt;.+)\.docx" directory="results" visible="false" format="docx"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
54 </collection>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
55 </outputs>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
56 <tests>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
57 <test expect_num_outputs="3">
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
58 <param name="fiche_val" value="ficheterrain.csv"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
59 <param name="input_data" value="champbloc_ivr.csv"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
60 <output name="output_ivr">
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
61 <assert_contents>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
62 <has_text text="yo"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
63 </assert_contents>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
64 </output>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
65 <output_collection name="plots" type="list" count="23"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
66 <output_collection name="output_report" type="list" count="23"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
67 </test>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
68 </tests>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
69 <help><![CDATA[
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
70 =============
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
71 VTI indicator
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
72 =============
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
73
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
74
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
75 **What it does**
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
76
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
77 Calculates the Visual Boulder Turning Indicator (VTI), which is similar to a "landscape" indicator to assess fishing pressure based on architectural criteria.
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
78 Based on the proportion of "turned" and "not turned" blocs this indicator vary from 0 to 5 and can be quickly used.
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
79
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
80 **Input description**
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
81
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
82 TWO input files in csv format.
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
83
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
84 +---------------+------------------+
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
85 | CSV | CSV |
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
86 +===============+==================+
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
87 | champbloc.csv | ficheterrain.csv |
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
88 +---------------+------------------+
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
89 | ... | ... |
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
90 +---------------+------------------+
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
91
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
92
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
93 **Output**
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
94
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
95 - .RDS file 1 of them for the ivr
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
96 - Multiple png plots one for each of the locations
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
97
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
98
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
99 ]]> </help>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
100 <expand macro="cb_bibref"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
101 </tool>