annotate sample_filter.xml @ 1:d2f75a01c428 draft

"planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 680116d0cf6a6d7246cba655452dea43269aeba4"
author computational-metabolomics
date Tue, 28 Apr 2020 17:37:36 -0400
parents 415fe844ec6c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
1 <tool id="dimspy_sample_filter" name="Sample Filter" version="@TOOL_VERSION@+galaxy@GALAXY_TOOL_VERSION@">
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
2 <description>Remove peaks that fail to appear in x-out-of-n (biological) samples</description>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
3 <macros>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
4 <import>macros.xml</import>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
5 </macros>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
6 <expand macro="requirements" />
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
7 <command detect_errors="exit_code">
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
8 <![CDATA[
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
9 dimspy sample-filter
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
10 --input '$hdf5_file_in'
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
11 --output '$hdf5_file_out'
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
12 --min-fraction $min_fraction
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
13 ${within}
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
14 #if $rsd_threshold
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
15 --rsd-threshold $rsd_threshold
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
16 #end if
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
17 #if $qc_label
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
18 --qc-label '$qc_label'
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
19 #end if
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
20 #if $hdf5_to_txt.standard
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
21 &&
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
22 @HDF5_PM_TO_TXT@
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
23 #end if
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
24 #if $hdf5_to_txt.comprehensive
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
25 &&
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
26 @HDF5_PM_TO_TXT_COMPREHENSIVE@
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
27 #end if
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
28 ]]>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
29 </command>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
30 <inputs>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
31 <param name="hdf5_file_in" argument="--input" type="data" format="h5" label="Peak Intensity Matrix (HDF5 file)" help="" />
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
32 <param name="within" argument="--within" type="boolean" checked="false" truevalue="--within" falsevalue="" label="Apply sample filter within each sample class." help="" />
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
33 <param name="min_fraction" argument="--min-fraction" type="float" min="0" max="1.0" value="0.5" label="Minimum fraction" help="Minimum fraction (i.e. percentage) of samples a peak has to be present" />
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
34 <param name="rsd_threshold" type="hidden" value="" label="Relative standard deviation threshold" help="Leave empty to skip this step" argument="--rsd-threshold"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
35 <param name="qc_label" argument="--qc-label" type="hidden" value="" label="Label for the QC sample (RSD filter only)" help="Peaks that have a larger RSD than the QC peaks are removed (Leave empty to skip this step)." >
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
36 <validator type="regex" message="Value may include alphanumeric characters, underscores, dashes and spaces.">[A-Za-z0-9_\- ]*</validator>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
37 </param>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
38 <param name="delimiter" argument="--delimiter" type="hidden" value="tab" label="" help=""/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
39 <expand macro="hdf5_pm_to_txt" />
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
40 </inputs>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
41 <outputs>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
42 <expand macro="outputs_peak_intensity_matrix" />
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
43 </outputs>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
44 <tests>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
45 <test>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
46 <param name="hdf5_file_in" value="pm_as_bf.h5" ftype="h5"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
47 <param name="within" value=""/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
48 <param name="min_fraction" value="0.5"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
49 <param name="rsd_threshold" value=""/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
50 <param name="qc_label" value=""/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
51 <param name="delimiter" value="tab"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
52 <conditional name="hdf5_to_txt">
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
53 <param name="standard" value="True"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
54 <param name="comprehensive" value="True"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
55 <param name="representation_samples" value="rows"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
56 <param name="matrix_attr" value="intensity"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
57 </conditional>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
58 <output name="hdf5_file_out" file="pm_as_bf_sf.h5" ftype="h5" compare="sim_size"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
59 <output name="matrix_file_out" file="peak_matrix_as_bf_sf.txt" ftype="tsv" compare="sim_size"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
60 <output name="matrix_comprehensive_file_out" file="peak_matrix_as_bf_sf_compr.txt" ftype="tsv"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
61 </test>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
62 <test>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
63 <param name="hdf5_file_in" value="pm_as_bf.h5" ftype="h5"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
64 <param name="within" value=""/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
65 <param name="min_fraction" value="0.5"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
66 <param name="rsd_threshold" value=""/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
67 <param name="qc_label" value=""/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
68 <param name="delimiter" value="tab"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
69 <conditional name="hdf5_to_txt">
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
70 <param name="standard" value="True"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
71 <param name="comprehensive" value="True"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
72 <param name="representation_samples" value="columns"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
73 <param name="matrix_attr" value="mz"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
74 </conditional>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
75 <output name="hdf5_file_out" file="pm_as_bf_sf.h5" ftype="h5" compare="sim_size"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
76 <output name="matrix_file_out" file="peak_matrix_as_bf_sf_mz.txt" ftype="tsv"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
77 <output name="matrix_comprehensive_file_out" file="peak_matrix_as_bf_sf_mz_compr.txt" ftype="tsv"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
78 </test>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
79 <test>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
80 <param name="hdf5_file_in" value="pm_as_bf.h5" ftype="h5"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
81 <param name="within" value="--within"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
82 <param name="min_fraction" value="0.5"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
83 <param name="rsd_threshold" value=""/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
84 <param name="qc_label" value=""/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
85 <param name="delimiter" value="tab"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
86 <conditional name="hdf5_to_txt">
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
87 <param name="standard" value="True"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
88 <param name="comprehensive" value="True"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
89 <param name="representation_samples" value="rows"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
90 <param name="matrix_attr" value="intensity"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
91 </conditional>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
92 <output name="hdf5_file_out" file="pm_as_bf_sf_within.h5" ftype="h5" compare="sim_size"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
93 <output name="matrix_file_out" file="peak_matrix_as_bf_sf_within.txt" ftype="tsv"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
94 <output name="matrix_comprehensive_file_out" file="peak_matrix_as_bf_sf_within_compr.txt" ftype="tsv"/>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
95 </test>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
96 </tests>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
97 <help>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
98 -------------
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
99 Sample Filter
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
100 -------------
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
101
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
102 ..
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
103
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
104 ----------------------------------------------
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
105
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
106 Description
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
107 -----------
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
108
1
d2f75a01c428 "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 680116d0cf6a6d7246cba655452dea43269aeba4"
computational-metabolomics
parents: 0
diff changeset
109 Standard DIMS processing workflow: Process Scans -> [Replicate Filter] -> Align Samples -> Blank Filter -> **Sample Filter** -> [Missing values sample filter] -> Pre-processing -> Statistics
0
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
110
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
111 |
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
112
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
113 There are many and varied reasons why a peak may not have been detected in all study samples, including: due to having an intensity (concentration) close to the signal-to-noise limit of the system; due to having been present in only one of the study classes (e.g. a drug administered to the ‘treatment’ class samples); due to ion suppression/enhancement effects in the mass spectrometer source region; etc. The Sample Filter tool allows users to remove peaks from the input peak intensity matrix that were detected in fewer-than a user-defined minimum number of study samples.
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
114
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
115 ------------------------------------
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
116
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
117 Parameters
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
118 -----------
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
119
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
120 **Peak Intensity Matrix (HDF5 file)** (REQUIRED) - a HDF5 file containing the peak intensity matrix to undergo sample filtering.
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
121
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
122
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
123 **Apply sample filter within each sample class** (REQUIRED; default **No**)
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
124
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
125 - **No** - check across ALL classes simultaneously whether greater-than the user-defined “Minimum fraction” of samples contained an intensity value for a specific mass spectral peak.
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
126
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
127 - **Yes** - check within EACH class separately whether greater-than the user-defined “Minimum fraction” of samples contained an intensity value for a specific mass spectral peak.
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
128
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
129 **IMPORTANT**: if in ANY class a peak is detected in greater-than the user-defined minimum fraction of samples, then the peak is retained in the output peak matrix. For classes in which this condition is not met, the peak intensity recorded for that peak (if any) will still be presented in the output peak matrix. If no peak intensity was recorded in a sample, then a ‘0’ is inserted in to the peak matrix.
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
130
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
131
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
132 **Minimum fraction** (REQUIRED, default 0.5) - a numeric value between 0 and 1 indicating the proportion of study samples in which a peak must have a recorded intensity value in order for it to be retained in the output peak intensity matrix; e.g. 0.5 means that at least 50% of samples (whether assessed across all classes, or within each class individually) must have a recorded intensity value for a specific peak in order for it to be retained in the output peak matrix.
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
133
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
134 |
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
135
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
136 @help_options_addtional_output@
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
137
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
138 -------------------------------
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
139
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
140
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
141 Output file(s)
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
142 --------------
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
143
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
144 **IMPORTANT** - in all outputs except for the (optional) comprehensive output, if fewer-than the user-defined “Minimum fraction” of samples (whether assessed within a class, or across all classes) had a recorded intensity value (either within or across classes) for a given peak, then that peak will be removed from the output peak matrix. Note that when assessing within classes, only one class needs to have recorded intensity values in greater-than the "Minimum fraction" of samples in order for the peak to be retained in the output peak matrix.
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
145
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
146 @help_outputs_matrix@
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
147
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
148 -------------------------------------
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
149
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
150 @github_developers_contributors@
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
151 @license@
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
152 </help>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
153 <expand macro="citations" />
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
154 </tool>
415fe844ec6c "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
155