annotate extract_ipm_date_interval.xml @ 11:2a438187d051 draft

Uploaded
author greg
date Wed, 08 Aug 2018 14:08:11 -0400
parents c2eb16ef23c0
children fff2e4833e8f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4dccc60b3525 Uploaded
greg
parents:
diff changeset
1 <tool id="ipm_date_interval" name="Extract date interval" version="1.1.0">
4dccc60b3525 Uploaded
greg
parents:
diff changeset
2 <description>from insect phenology model data</description>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
3 <requirements>
10
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
4 <requirement type="package" version="1.10.4">r-data.table</requirement>
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
5 <requirement type="package" version="2.2.6">r-hash</requirement>
0
4dccc60b3525 Uploaded
greg
parents:
diff changeset
6 <requirement type="package" version="1.4.4">r-optparse</requirement>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
7 </requirements>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
4dccc60b3525 Uploaded
greg
parents:
diff changeset
9 #import os
10
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
10 #set input_data_dir = 'input_data_dir'
0
4dccc60b3525 Uploaded
greg
parents:
diff changeset
11 #set output_data_dir = "output_data_dir"
4dccc60b3525 Uploaded
greg
parents:
diff changeset
12 #set output_plots_dir = "output_plots_dir"
4dccc60b3525 Uploaded
greg
parents:
diff changeset
13 #set error_file = $os.path.join($output_data_dir, "04_combined_generations.csv")
10
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
14 #set job = $input_data[0].creating_job
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
15 #set tool_parameters = ""
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
16 #for $p in $job.parameters:
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
17 #set tool_parameters = $tool_parameters + "__SeP__" + $p.name
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
18 #set tool_parameters = $tool_parameters + "__SeP__" + $p.value
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
19 #end for
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
20 mkdir $input_data_dir &&
0
4dccc60b3525 Uploaded
greg
parents:
diff changeset
21 mkdir output_data_dir &&
4dccc60b3525 Uploaded
greg
parents:
diff changeset
22 mkdir output_plots_dir &&
10
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
23 #for $i in $input_data:
0
4dccc60b3525 Uploaded
greg
parents:
diff changeset
24 #set filename = $i.file_name
4dccc60b3525 Uploaded
greg
parents:
diff changeset
25 #set name = $i.name
10
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
26 ln -s $filename $input_data_dir/$name &&
0
4dccc60b3525 Uploaded
greg
parents:
diff changeset
27 #end for
4dccc60b3525 Uploaded
greg
parents:
diff changeset
28 Rscript '$__tool_directory__/extract_ipm_date_interval.R'
4dccc60b3525 Uploaded
greg
parents:
diff changeset
29 --end_date '$end_date'
10
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
30 --input_data_dir '$input_data_dir'
0
4dccc60b3525 Uploaded
greg
parents:
diff changeset
31 --script_dir '$__tool_directory__'
4dccc60b3525 Uploaded
greg
parents:
diff changeset
32 --start_date '$start_date'
10
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
33 --tool_parameters '$tool_parameters'
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
34 &>eipmdi_log.txt;
0
4dccc60b3525 Uploaded
greg
parents:
diff changeset
35 if [[ $? -ne 0 ]]; then
10
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
36 cp eipmdi_log.txt '$error_file';
0
4dccc60b3525 Uploaded
greg
parents:
diff changeset
37 exit 1;
4dccc60b3525 Uploaded
greg
parents:
diff changeset
38 fi]]></command>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
39 <inputs>
10
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
40 <param name="input_data" type="data_collection" format="csv" collection_type="list" label="Insect phenology model data files" />
0
4dccc60b3525 Uploaded
greg
parents:
diff changeset
41 <param name="start_date" type="text" value="" label="Start date" help="Format must be yyyy-mm-dd">
4dccc60b3525 Uploaded
greg
parents:
diff changeset
42 <validator type="expression" message="Date must have the format yyyy-mm-dd">len(value.split('-')[0])==4 and int(value.split('-')[0]) and len(value.split('-')[1])==2 and int(value.split('-')[1]) and len(value.split('-')[2])==2 and int(value.split('-')[2])</validator>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
43 </param>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
44 <param name="end_date" type="text" value="" label="End date" help="Format must be yyyy-mm-dd">
4dccc60b3525 Uploaded
greg
parents:
diff changeset
45 <validator type="expression" message="Date must have the format yyyy-mm-dd">len(value.split('-')[0])==4 and int(value.split('-')[0]) and len(value.split('-')[1])==2 and int(value.split('-')[1]) and len(value.split('-')[2])==2 and int(value.split('-')[2])</validator>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
46 </param>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
47 </inputs>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
48 <outputs>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
49 <collection name="output_data_collection" type="list" label="${tool.name} (data), on ${on_string}">
4dccc60b3525 Uploaded
greg
parents:
diff changeset
50 <discover_datasets pattern="__name__" directory="output_data_dir" format="csv"/>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
51 </collection>
10
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
52 <collection name="output_plot_collection" type="list" label="${tool.name} (plots), on ${on_string}">
0
4dccc60b3525 Uploaded
greg
parents:
diff changeset
53 <discover_datasets pattern="__name__" directory="output_plots_dir" format="pdf"/>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
54 </collection>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
55 </outputs>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
56 <tests>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
57 <test>
10
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
58 <!--
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
59 FIXME: Here is a sort of layout for a test, but since the input collection will be uploaded, the test
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
60 will fail bacused the job parameters for the inputs will not be those produced by the insect_phenology_model
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
61 tool. Testing this tool will require using the workflow testing approach.
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
62 <param name="input_data">
0
4dccc60b3525 Uploaded
greg
parents:
diff changeset
63 <collection type="list">
10
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
64 <element name="input_p_1.csv" value="input_p_1.csv" ftype="csv"/>
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
65 <element name="input_f1_1.csv" value="input_f1_1.csv" ftype="csv"/>
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
66 <element name="input_f2_1.csv" value="input_f2_1.csv" ftype="csv"/>
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
67 <element name="input_combined1.csv" value="input_combined1.csv" ftype="csv"/>
0
4dccc60b3525 Uploaded
greg
parents:
diff changeset
68 </collection>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
69 </param>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
70 <param name="start_date" value="2017-04-01"/>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
71 <param name="end_date" value="2017-04-15"/>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
72 <output_collection name="output_data_collection" type="list">
10
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
73 <element name="01_generation_P.csv" file="output_p_1.csv" ftype="csv" compare="contains"/>
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
74 <element name="02_generation_F1.csv" file="output_f1_1.csv" ftype="csv" compare="contains"/>
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
75 <element name="03_generation_F2.csv" file="output_f2_1.csv" ftype="csv" compare="contains"/>
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
76 <element name="04_combined_generations.csv" file="output_combined1.csv" ftype="csv" compare="contains"/>
0
4dccc60b3525 Uploaded
greg
parents:
diff changeset
77 </output_collection>
10
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
78 <output_collection name="output_plot_collection" type="list">
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
79 <element name="01_egg_pop_by_generation.pdf" file="plot.pdf" ftype="pdf" compare="contains"/>
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
80 <element name="04_total_nymph_pop_by_generation.pdf" file="plot.pdf" ftype="pdf" compare="contains"/>
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
81 <element name="08_total_adult_pop_by_generation.pdf" file="plot.pdf" ftype="pdf" compare="contains"/>
c2eb16ef23c0 Uploaded
greg
parents: 1
diff changeset
82 <element name="09_total_pop_by_generation.pdf" file="plot.pdf" ftype="pdf" compare="contains"/>
0
4dccc60b3525 Uploaded
greg
parents:
diff changeset
83 </output_collection>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
84 -->
4dccc60b3525 Uploaded
greg
parents:
diff changeset
85 </test>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
86 </tests>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
87 <help>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
88 **What it does**
4dccc60b3525 Uploaded
greg
parents:
diff changeset
89
4dccc60b3525 Uploaded
greg
parents:
diff changeset
90 Provides an agent-based stochastic model expressing stage-specific phenology and population dynamics for an insect species across geographic regions.
4dccc60b3525 Uploaded
greg
parents:
diff changeset
91
4dccc60b3525 Uploaded
greg
parents:
diff changeset
92 -----
4dccc60b3525 Uploaded
greg
parents:
diff changeset
93
4dccc60b3525 Uploaded
greg
parents:
diff changeset
94 **Required options**
4dccc60b3525 Uploaded
greg
parents:
diff changeset
95
4dccc60b3525 Uploaded
greg
parents:
diff changeset
96 * **Plot standard error** - add standard error lines to plot.
4dccc60b3525 Uploaded
greg
parents:
diff changeset
97 </help>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
98 <citations>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
99 <citation type="doi">10.3389/fphys.2016.00165</citation>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
100 <citation type="doi">10.1175/JTECH-D-11-00103.1</citation>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
101 <citation type="doi">10.7289/V5D21VHZ</citation>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
102 </citations>
4dccc60b3525 Uploaded
greg
parents:
diff changeset
103 </tool>