annotate aplcms_hybrid.xml @ 3:2877bbac4c82 draft default tip

"planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ffadabe63b4a1428918cb80dc1f8598f41a458bd"
author recetox
date Mon, 17 May 2021 09:08:39 +0000
parents a1439454fe7f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
1 <tool id="aplcms_hybrid" name="apLCMS - Hybrid" version="@TOOL_VERSION@+galaxy3">
0
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
2 <macros>
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
3 <import>aplcms_macros.xml</import>
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
4 </macros>
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
5
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
6 <expand macro="requirements" />
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
7
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
8 <command detect_errors="aggressive"><![CDATA[
2
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
9 Rscript ${run_script}
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
10 ]]></command>
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
11
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
12 <configfiles>
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
13 <configfile name="run_script"><![CDATA[
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
14 #set file_str = str("', '").join([str($f) for $f in $files])
0
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
15
2
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
16 x <- apLCMS::hybrid(
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
17 files = c('$file_str'),
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
18 known_table = apLCMS::load_known_table_from_hdf('$known_table'),
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
19 min_exp = $noise_filtering.min_exp,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
20 min_pres = $noise_filtering.min_pres,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
21 min_run = $noise_filtering.min_run,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
22 mz_tol = $noise_filtering.mz_tol,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
23 baseline_correct = $noise_filtering.baseline_correct,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
24 baseline_correct_noise_percentile = $noise_filtering.baseline_correct_noise_percentile,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
25 intensity_weighted = $noise_filtering.intensity_weighted,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
26 shape_model = '$feature_detection.shape_model',
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
27 BIC_factor = $feature_detection.BIC_factor,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
28 peak_estim_method = '$feature_detection.peak_estim_method',
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
29 min_bandwidth = $feature_detection.min_bandwidth,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
30 max_bandwidth = $feature_detection.max_bandwidth,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
31 sd_cut = c($feature_detection.sd_cut_min, $feature_detection.sd_cut_max),
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
32 sigma_ratio_lim = c($feature_detection.sigma_ratio_lim_min, $feature_detection.sigma_ratio_lim_max),
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
33 component_eliminate = $feature_detection.component_eliminate,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
34 moment_power = $feature_detection.moment_power,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
35 align_chr_tol = $peak_alignment.align_chr_tol,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
36 align_mz_tol = $peak_alignment.align_mz_tol,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
37 max_align_mz_diff = $peak_alignment.max_align_mz_diff,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
38 match_tol_ppm = $history_db.match_tol_ppm,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
39 new_feature_min_count = $history_db.new_feature_min_count,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
40 recover_mz_range = $weak_signal_recovery.recover_mz_range,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
41 recover_chr_range = $weak_signal_recovery.recover_chr_range,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
42 use_observed_range = $weak_signal_recovery.use_observed_range,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
43 recover_min_count = $weak_signal_recovery.recover_min_count,
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
44 cluster = as.integer(Sys.getenv('GALAXY_SLOTS', unset = 1))
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
45 )
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
46
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
47 apLCMS::save_peaks_to_hdf('$peaks', x)
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
48 apLCMS::save_known_table_to_hdf('$updated_known_table', x\$updated_known_table) ## NOTE the \ because we want cheetah to ignore the $ character
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
49 ]]></configfile>
a1439454fe7f "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ef35fcaaee8f8ae4aa72f3bc0f47dc20e0e70116"
recetox
parents: 1
diff changeset
50 </configfiles>
0
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
51
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
52 <expand macro="inputs">
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
53 <expand macro="history_db" />
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
54 <expand macro="noise_filtering" />
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
55 <expand macro="feature_detection" />
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
56 <expand macro="peak_alignment" />
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
57 <expand macro="weak_signal_recovery" />
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
58 </expand>
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
59
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
60 <outputs>
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
61 <data name="peaks" format="h5" />
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
62 <data name="updated_known_table" format="h5" />
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
63 </outputs>
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
64
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
65 <tests>
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
66 <test>
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
67 <param name="files" value="mbr_test0.mzml,mbr_test1.mzml,mbr_test2.mzml" ftype="mzml"/>
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
68 <param name="known_table" value="known_table.h5" ftype="h5"/>
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
69 <output name="peaks" file="peaks_hybrid.h5" ftype="h5" compare="sim_size" delta="1000"/>
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
70 </test>
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
71 </tests>
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
72
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
73 <help>
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
74 This is the Hybrid version of apLCMS which is incorporating the knowledge of known metabolites and historically
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
75 detected features on the same machinery to help detect and quantify lower-intensity peaks.
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
76
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
77 CAUTION: To use such knowledge, especially historical data, you must keep using (1) the same chromatography
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
78 system (otherwise the retention time will not match), and (2) the same type of samples with similar extraction
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
79 technique, such as human serum.
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
80
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
81 @GENERAL_HELP@
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
82 </help>
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
83
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
84 <expand macro="citations" />
d3d9ba599d51 "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit ecdfe141b4320e754cc9f3673cc33b7673441ed8"
recetox
parents:
diff changeset
85 </tool>