annotate cb_ivr.xml @ 1:b67730406f1b draft

planemo upload for repository https://github.com/Marie59/champ_blocs commit 0d86db7d42b608c386a54500064f5f9c9d7019a4
author ecology
date Wed, 04 Jan 2023 13:21:30 +0000
parents 8c6142630659
children bcbad4f83dec
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
1 <tool id="cb_ivr" name="IVR" version="@VERSION@" profile = "20.01">
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>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
6 <expand macro="cb_requirements">
1
b67730406f1b planemo upload for repository https://github.com/Marie59/champ_blocs commit 0d86db7d42b608c386a54500064f5f9c9d7019a4
ecology
parents: 0
diff changeset
7 <requirement type="package" version="2.19">r-rmarkdown</requirement>
0
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
8 <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
9 <requirement type="package" version="1.3.2">r-tidyverse</requirement>
1
b67730406f1b planemo upload for repository https://github.com/Marie59/champ_blocs commit 0d86db7d42b608c386a54500064f5f9c9d7019a4
ecology
parents: 0
diff changeset
10 <requirement type="package" version="0.5.0">r-officer</requirement>
b67730406f1b planemo upload for repository https://github.com/Marie59/champ_blocs commit 0d86db7d42b608c386a54500064f5f9c9d7019a4
ecology
parents: 0
diff changeset
11 <requirement type="package" version="0.8.3">r-flextable</requirement>
b67730406f1b planemo upload for repository https://github.com/Marie59/champ_blocs commit 0d86db7d42b608c386a54500064f5f9c9d7019a4
ecology
parents: 0
diff changeset
12 <requirement type="package" version="3.4">r-ggplot2</requirement>
0
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
13 </expand>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
14 <required_files>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
15 <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
16 <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
17 <include type="literal" path="CB_ivr.tif"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
18 <include type="literal" path="logo_merged.png"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
19 <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
20 <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
21 <include type="literal" path="cb_ivr.r"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
22 </required_files>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
23 <command detect_errors="exit_code"><![CDATA[
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
24 Rscript
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
25 '$__tool_directory__/cb_ivr.r'
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
26 '$fiche_val'
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
27 '$input_data'
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
28 '$__tool_directory__/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
29 '$__tool_directory__/loop_col_scale.r'
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
30 '$output_ivr'
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
31 '$plots'
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
32 '$output_report'
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
33 ]]>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
34 </command>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
35 <inputs>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
36 <expand macro="cb_input"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
37 <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
38 </inputs>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
39 <outputs>
1
b67730406f1b planemo upload for repository https://github.com/Marie59/champ_blocs commit 0d86db7d42b608c386a54500064f5f9c9d7019a4
ecology
parents: 0
diff changeset
40 <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
41 <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
42 <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
43 </collection>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
44 <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
45 <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
46 </collection>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
47 </outputs>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
48 <tests>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
49 <test expect_num_outputs="3">
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
50 <param name="fiche_val" value="ficheterrain.csv"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
51 <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
52 <output name="output_ivr">
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
53 <assert_contents>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
54 <has_text text="yo"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
55 </assert_contents>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
56 </output>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
57 <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
58 <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
59 </test>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
60 </tests>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
61 <help><![CDATA[
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
62 =============
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
63 VTI indicator
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
64 =============
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
65
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
66
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
67 **What it does**
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
68
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
69 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
70 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
71
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
72 **Input description**
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 TWO input files in csv format.
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
75
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 | CSV | CSV |
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
78 +===============+==================+
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
79 | champbloc.csv | ficheterrain.csv |
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
80 +---------------+------------------+
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 +---------------+------------------+
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 **Output**
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 - .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
88 - 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
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 ]]> </help>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
92 <expand macro="cb_bibref"/>
8c6142630659 planemo upload for repository https://github.com/Marie59/champ_blocs commit 8b6fcddd239979c11977472de6cbb349690758c8
ecology
parents:
diff changeset
93 </tool>