annotate raster_getdata.xml @ 6:4507b52cbb7a draft default tip

Uploaded
author mnhn65mo
date Mon, 13 Aug 2018 10:08:10 -0400
parents c29f8b25651c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
1 <tool id="raster_getdata" name="Get climatic data from Worldclim" version="0.1.0">
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
2 <requirements>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
3 <requirement type="package" version="1.20.2">r-getopt</requirement>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
4 <requirement type="package" version="1.1.6">r-ncdf4</requirement>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
5 <requirement type="package" version="2.6_7">r-raster</requirement>
2
65b9ca4df74a Uploaded
mnhn65mo
parents: 1
diff changeset
6 <requirement type="package" version="1.3.1">r-stringr</requirement>
0
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
7 </requirements>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
9 Rscript
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
10 '$__tool_directory__/clim_data.R'
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
11 'worldclim'
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
12 '$usr_var'
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
13 $usr_res
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
14 '$usr_of'
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
15
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
16 #if $condi_plot.plot=='yes_plot'
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
17 '$usr_var$condi_plot.var_to_plot'
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
18 '$condi_plot.usr_country'
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
19 #end if
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
20
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
21 ]]></command>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
22 <inputs>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
23 <param name="usr_var" type="select" label="Variable" help="Temperature minimum, maximum, precipitations and bioclimatic variables.">
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
24 <option value="tmin">tmin</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
25 <option value="tmax">tmax</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
26 <option value="prec">prec</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
27 <option value="bio">bio</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
28 </param>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
29 <param name="usr_res" type="select" label="Resolution" help="In minutes of a degree.">
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
30 <option value="2.5">2.5</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
31 <option value="5">5</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
32 <option value="10">10</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
33 </param>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
34 <param name="usr_of" type="select" label="Output raster format" >
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
35 <option value="raster">Native raster package format .grd</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
36 <option value="CDF">netCDF .nc</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
37 </param>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
38 <conditional name="condi_plot">
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
39 <param name="plot" type="select" label="Return a layers visualisation">
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
40 <option value="yes_plot">Yes</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
41 <option value="no_plot">No</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
42 </param>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
43 <when value="yes_plot">
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
44 <param name="var_to_plot" type="select" label="Select what you want to visualize" help="Be careful to select a layer that is present in the dowloaded raster. eg : bioclimatic variable (bio) and layer bio:Isothermality.">
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
45 <option value="1">[tmin|tmax|prec]:January</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
46 <option value="2">[tmin|tmax|prec]:February</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
47 <option value="3">[tmin|tmax|prec]:March</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
48 <option value="4">[tmin|tmax|prec]:April</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
49 <option value="5">[tmin|tmax|prec]:May</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
50 <option value="6">[tmin|tmax|prec]:June</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
51 <option value="7">[tmin|tmax|prec]:July</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
52 <option value="8">[tmin|tmax|prec]:August</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
53 <option value="9">[tmin|tmax|prec]:September</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
54 <option value="10">[tmin|tmax|prec]:October</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
55 <option value="11">[tmin|tmax|prec]:November</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
56 <option value="12">[tmin|tmax|prec]:December</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
57 <option value="1">bio:Annual Mean Temperature</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
58 <option value="2">bio:Mean Diurnal Range (Mean of monthly (max temp - min temp))</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
59 <option value="3">bio:Isothermality (BIO2/BIO7) (* 100)</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
60 <option value="4">bio:Temperature Seasonality (standard deviation *100)</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
61 <option value="5">bio:Max Temperature of Warmest Month</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
62 <option value="6">bio:Min Temperature of Coldest Month</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
63 <option value="7">bio:Temperature Annual Range (BIO5-BIO6)</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
64 <option value="8">bio:Mean Temperature of Wettest Quarter</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
65 <option value="9">bio:Mean Temperature of Driest Quarter</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
66 <option value="10">bio:Mean Temperature of Warmest Quarter</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
67 <option value="11">bio:Mean Temperature of Coldest Quarter</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
68 <option value="12">bio:Annual Precipitation</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
69 <option value="13">bio:Precipitation of Wettest Month</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
70 <option value="14">bio:Precipitation of Driest Month</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
71 <option value="15">bio:Precipitation Seasonality (Coefficient of Variation)</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
72 <option value="16">bio:Precipitation of Wettest Quarter</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
73 <option value="17">bio:Precipitation of Driest Quarter</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
74 <option value="18">bio:Precipitation of Warmest Quarter</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
75 <option value="19">bio:Precipitation of Coldest Quarter</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
76 </param>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
77
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
78 <param name="usr_country" type="select" label="Select a worldmap vision or a more precise region" >
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
79 <option value="WM">Worldmap</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
80 <option value="NA">North America</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
81 <option value="EU">Europe</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
82 <option value="AUS">Australia</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
83 <option value="FRA">France</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
84 <option value="DEU">Germany</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
85 <option value="GBR">United Kingdom</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
86 <option value="ESP">Spain</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
87 <option value="ITA">Italy</option>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
88 </param>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
89 </when>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
90 <when value="no_plot">
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
91 </when>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
92 </conditional>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
93 </inputs>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
94 <outputs>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
95 <data name="output_df" from_work_dir="output_writeRaster.nc" label="WorldClim data - NetCDF format">
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
96 <filter> usr_of=='CDF'</filter>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
97 </data>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
98 <data name="output_grd" from_work_dir="output_writeRaster.grd" label="WorldClim data - Native raster pkg format .grd">
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
99 <filter> usr_of=='raster'</filter>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
100 </data>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
101 <data name="output_gri" from_work_dir="output_writeRaster.gri" label="WorldClim data - Native raster pkg format .gri">
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
102 <filter> usr_of=='raster'</filter>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
103 </data>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
104 <data name="plot_jpeg" from_work_dir="worldclim_plot_usr_region.jpeg" format="jpg" label="WorldClim data - Visualisation">
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
105 <filter> plot=='yes_plot'</filter>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
106 </data>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
107 </outputs>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
108 <help><![CDATA[
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
109
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
110 .. class:: infomark
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
111
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
112 =======================================
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
113 Get global climate data from Worldclim
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
114 =======================================
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
115
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
116 |
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
117
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
118 **What it does**
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
119
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
120 This tool retrieve global climate data from Wordclim using the R raster package.
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
121
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
122 The climatic data available are :
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
123
4
4ba0045984f7 Uploaded
mnhn65mo
parents: 3
diff changeset
124 * Minimum temperature (°C x10)
0
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
125
4
4ba0045984f7 Uploaded
mnhn65mo
parents: 3
diff changeset
126 * Maximum temperature (°C x10)
0
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
127
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
128 * Precipitation (mm)
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
129
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
130 * Bioclimatic variables :
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
131
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
132 * BIO1 = Annual Mean Temperature
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
133
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
134 * BIO2 = Mean Diurnal Range (Mean of monthly (max temp - min temp))
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
135
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
136 * BIO3 = Isothermality (BIO2/BIO7) (x 100)
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
137
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
138 * BIO4 = Temperature Seasonality (standard deviation x100)
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
139
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
140 * BIO5 = Max Temperature of Warmest Month
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
141
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
142 * BIO6 = Min Temperature of Coldest Month
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
143
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
144 * BIO7 = Temperature Annual Range (BIO5-BIO6)
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
145
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
146 * BIO8 = Mean Temperature of Wettest Quarter
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
147
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
148 * BIO9 = Mean Temperature of Driest Quarter
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
149
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
150 * BIO10 = Mean Temperature of Warmest Quarter
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
151
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
152 * BIO11 = Mean Temperature of Coldest Quarter
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
153
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
154 * BIO12 = Annual Precipitation
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
155
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
156 * BIO13 = Precipitation of Wettest Month
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
157
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
158 * BIO14 = Precipitation of Driest Month
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
159
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
160 * BIO15 = Precipitation Seasonality (Coefficient of Variation)
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
161
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
162 * BIO16 = Precipitation of Wettest Quarter
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
163
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
164 * BIO17 = Precipitation of Driest Quarter
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
165
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
166 * BIO18 = Precipitation of Warmest Quarter
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
167
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
168 * BIO19 = Precipitation of Coldest Quarter
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
169
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
170 |
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
171
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
172 **How to use it**
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
173
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
174 Simply select the variable to return and the resolution : 2.5, 5 or 10 minutes of a degree.
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
175
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
176 Available output format are : netcdf and grd (Native raster package format).
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
177
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
178 |
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
179
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
180 **Sources**
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
181
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
182 Worldclim : http://www.worldclim.org/
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
183
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
184 Raster package : https://cran.r-project.org/web/packages/raster/index.html
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
185
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
186 ]]></help>
bdf7d9f2ddae Uploaded
mnhn65mo
parents:
diff changeset
187 </tool>