annotate aplcms_hybrid.xml @ 1:30b1888f985a draft

"planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
author recetox
date Thu, 24 Sep 2020 00:16:24 +0000
parents 2bb3c7ae9777
children bb4ffaeba411
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
1 <tool id="recetox_aplcms_hybrid" name="apLCMS - Hybrid" version="@TOOL_VERSION@+galaxy0">
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
2 <macros>
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
3 <import>aplcms_macros.xml</import>
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
4 </macros>
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
5
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
6 <expand macro="requirements" />
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
7
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
8 <command detect_errors="aggressive"><![CDATA[
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
9 #set file_str = str('", "').join([str($f) for $f in $files])
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
10
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
11 Rscript
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
12 -e 'x <- apLCMS::hybrid(
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
13 files = c("$file_str"),
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
14 known_table = rhdf5::h5read("$known_table", "aplcms_known_table"),
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
15 min_exp = $noise_filtering.min_exp,
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
16 min_pres = $noise_filtering.min_pres,
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
17 min_run = $noise_filtering.min_run,
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
18 mz_tol = $noise_filtering.mz_tol,
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
19 baseline_correct = $noise_filtering.baseline_correct,
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
20 baseline_correct_noise_percentile = $noise_filtering.baseline_correct_noise_percentile,
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
21 intensity_weighted = $noise_filtering.intensity_weighted,
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
22 shape_model = "$feature_detection.shape_model",
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
23 BIC_factor = $feature_detection.BIC_factor,
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
24 peak_estim_method = "$feature_detection.peak_estim_method",
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
25 min_bandwidth = $feature_detection.min_bandwidth,
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
26 max_bandwidth = $feature_detection.max_bandwidth,
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
27 sd_cut = c($feature_detection.sd_cut_min, $feature_detection.sd_cut_max),
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
28 sigma_ratio_lim = c($feature_detection.sigma_ratio_lim_min, $feature_detection.sigma_ratio_lim_max),
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
29 component_eliminate = $feature_detection.component_eliminate,
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
30 moment_power = $feature_detection.moment_power,
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
31 align_chr_tol = $peak_alignment.align_chr_tol,
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
32 align_mz_tol = $peak_alignment.align_mz_tol,
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
33 max_align_mz_diff = $peak_alignment.max_align_mz_diff,
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
34 match_tol_ppm = $history_db.match_tol_ppm,
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
35 new_feature_min_count = $history_db.new_feature_min_count,
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
36 recover_mz_range = $weak_signal_recovery.recover_mz_range,
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
37 recover_chr_range = $weak_signal_recovery.recover_chr_range,
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
38 use_observed_range = $weak_signal_recovery.use_observed_range,
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
39 recover_min_count = $weak_signal_recovery.recover_min_count
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
40 )'
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
41 -e 'rhdf5::h5write(x\$final_peaks, "$peaks", "peaks")'
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
42 -e 'rhdf5::h5write(x\$aligned_peaks, "$peaks", "aligned_peaks")'
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
43 -e 'rhdf5::h5write(x\$corrected_features, "$peaks", "corrected_features")'
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
44 -e 'rhdf5::h5write(x\$extracted_features, "$peaks", "extracted_features")'
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
45 -e 'rhdf5::h5write(x\$aligned_mz_tolerance, "$peaks", "aligned_mz_tolerance")'
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
46 -e 'rhdf5::h5write(x\$aligned_rt_tolerance, "$peaks", "aligned_rt_tolerance")'
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
47 -e 'rhdf5::h5write(x\$updated_known_table, "$updated_known_table", "aplcms_known_table")'
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
48 ]]></command>
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
49
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
50 <expand macro="inputs">
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
51 <expand macro="history_db" />
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
52 <expand macro="noise_filtering" />
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
53 <expand macro="feature_detection" />
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
54 <expand macro="peak_alignment" />
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
55 <expand macro="weak_signal_recovery" />
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
56 </expand>
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
57
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
58 <outputs>
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
59 <data name="peaks" format="h5" />
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
60 <data name="updated_known_table" format="h5" />
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
61 </outputs>
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
62
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
63 <help>
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
64 This is the Hybrid version of apLCMS which is incorporating the knowledge of known metabolites and historically
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
65 detected features on the same machinery to help detect and quantify lower-intensity peaks.
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
66
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
67 CAUTION: To use such knowledge, especially historical data, you must keep using (1) the same chromatography
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
68 system (otherwise the retention time will not match), and (2) the same type of samples with similar extraction
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
69 technique, such as human serum.
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
70
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
71 @GENERAL_HELP@
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
72 </help>
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
73
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
74 <expand macro="citations" />
30b1888f985a "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/aplcms commit 5305d1a60fe5bf5f1abfec332d432b9d362f1f83"
recetox
parents: 0
diff changeset
75 </tool>