Mercurial > repos > iuc > fastspar_pvalues

annotate fastspar_pvalues.xml @ 0:7ff1304e12aa draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
author iuc
date Thu, 19 Jun 2025 21:51:18 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
1 <tool id="fastspar_pvalues" name="FastSpar: estimate p-values" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
2 <description>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
3 Bootstrap-based estimation of p-values from FastSpar correlations
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
4 </description>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
5 <macros>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
6 <import>macros.xml</import>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
7 </macros>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
8 <expand macro="biotools"/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
9 <expand macro="requirements_pvalues"/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
11 #if $correlation.select == "new"
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
12 fastspar
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
13 --otu_table '$otu_table'
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
14 --iterations $iterations
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
15 --exclude_iterations $exclude_iterations
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
16 --threshold $threshold
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
17 --seed $seed
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
18 --correlation '$output_correlation'
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
19 --covariance '$output_covariance'
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
20 --threads \${GALAXY_SLOTS:-1}
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
21 ## Skip warning prompt and continue analysis even if the input contains OTUs with just one permutation.
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
22 --yes &&
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
23 #set $correlation_file = $output_correlation
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
24 #else
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
25 #set $correlation_file = $correlation.input_file
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
26 #end if
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
27
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
28 mkdir bootstrap_counts
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
29 && fastspar_bootstrap
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
30 --otu_table '$otu_table'
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
31 --number $number
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
32 --prefix bootstrap_counts/data
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
33 --seed $seed
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
34 --threads \${GALAXY_SLOTS:-1}
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
35
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
36 && mkdir bootstrap_correlation
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
37 && parallel
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
38 --max-procs \${GALAXY_SLOTS:-1}
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
39 fastspar
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
40 --otu_table {}
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
41 --correlation bootstrap_correlation/cor_{/}
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
42 --covariance bootstrap_correlation/cov_{/}
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
43 --iterations $iterations
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
44 --exclude_iterations $exclude_iterations
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
45 --threshold $threshold
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
46 --seed $seed
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
47 ::: bootstrap_counts/*
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
48
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
49 && fastspar_pvalues
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
50 --otu_table '$otu_table'
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
51 --correlation '$correlation_file'
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
52 --prefix bootstrap_correlation/cor_data_
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
53 --permutations $number
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
54 $pseudo
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
55 --threads \${GALAXY_SLOTS:-1}
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
56 --outfile '$pvalues'
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
57 ]]></command>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
58 <inputs>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
59 <param argument="--otu_table" type="data" format="tabular" label="Input OTU table"
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
60 help="The table must contain absolute OTU counts in plain tabular (TSV) format, with OTUs as rows and samples as columns. Do not include any metadata rows or columns."/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
61 <conditional name="correlation">
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
62 <param name="select" type="select" label="Tested correlation matrix"
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
63 help="For meaningful p-values, the parameters used during bootstrapped correlation estimation should be identical to those used for the FastSpar run which produced the correlation matrix. &lt;br&gt;For your convenience you can choose to calculate the correlation matrix here. In that case the seed used for the calculation is the same one used for generating the bootstrapped samples.">
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
64 <option value="new">Recalculate the correlation matrix</option>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
65 <option value="original">Use an existing correlation matrix</option>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
66 </param>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
67 <when value="new"/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
68 <when value="original">
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
69 <param name="input_file" type="data" format="tabular" argument="--correlation" label="Correlation table" help="The correlation matrix generated by the original FastSpar analysis."/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
70 </when>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
71 </conditional>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
72 <param argument="--number" type="integer" min="10" max="10000" value="1000" label="Number of bootstrap samples" help="Recommended minimum: 1000 bootstrap samples for robust estimation."/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
73 <expand macro="fastspar_tool_parameters"/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
74 <param argument="--seed" type="integer" value="1" label="Seed to ensure reproducibility of bootstrapped samples."/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
75 <param argument="--pseudo" type="boolean" truevalue="--pseudo" falsevalue="" label="Use pseudo p-values" help="If selected, pseudo p-values are calculated instead of exact p-values. This can provide faster estimates but may be less precise."/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
76 </inputs>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
77 <outputs>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
78 <data name="output_correlation" format="tabular" label="${tool.name} on ${on_string}: median_correlation.tsv">
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
79 <filter>correlation['select'] == "new"</filter>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
80 </data>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
81 <data name="output_covariance" format="tabular" label="${tool.name} on ${on_string}: median_covariance.tsv">
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
82 <filter>correlation['select'] == "new"</filter>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
83 </data>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
84 <data name="pvalues" format="tabular" label="${tool.name} on ${on_string}: pvalues.tsv"/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
85 </outputs>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
86 <tests>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
87 <test expect_num_outputs="1">
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
88 <param name="otu_table" ftype="tabular" value="fake_data.tsv"/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
89 <conditional name="correlation">
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
90 <param name="select" value="original"/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
91 <param name="input_file" ftype="tabular" value="fake_data_cor.tsv"/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
92 </conditional>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
93 <param name="number" value="10"/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
94 <output name="pvalues" file="fake_pvalues.tsv" compare="diff"/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
95 </test>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
96 <test expect_num_outputs="3">
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
97 <param name="otu_table" ftype="tabular" value="fake_data.tsv"/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
98 <conditional name="correlation">
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
99 <param name="select" value="new"/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
100 </conditional>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
101 <param name="number" value="10"/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
102 <output name="output_correlation" file="fake_data_cor.tsv" compare="diff"/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
103 <output name="output_covariance" file="fake_data_cov.tsv" compare="diff"/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
104 <output name="pvalues" file="fake_pvalues.tsv" compare="diff"/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
105 </test>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
106 </tests>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
107 <help><![CDATA[
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
108 What it does
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
109 ============
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
110
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
111 This tool estimates **empirical p-values** for correlation values generated by FastSpar. It uses a **bootstrap-based permutation approach** to assess the statistical significance of observed correlations.
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
112
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
113 You can choose to recalculate the correlation matrix with the same parameters or use an existing correlation matrix.
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
114
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
115 How it works
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
116 ============
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
117
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
118 1. Generates multiple bootstrapped versions of the OTU table.
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
119 2. Runs FastSpar on each bootstrap replicate.
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
120 3. Compares bootstrapped correlations to the original correlation matrix to calculate empirical p-values.
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
121
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
122 Required Inputs
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
123 ===============
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
124
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
125 - **OTU table**: TSV file with absolute counts (no metadata).
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
126 - **Correlation table** (optional): Output from the original FastSpar run.
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
127 - **Bootstrap samples**: Number of bootstrap replicates (≥1000 recommended).
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
128
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
129 Important Parameters
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
130 ====================
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
131
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
132 - **Iterations**: Must match the number used in the original FastSpar run.
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
133 - **Exclude Iterations** and **Threshold**: Should also match the original settings, if used.
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
134 - **Seed**: Optional, for reproducibility.
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
135 - **Pseudo**: Choose whether to calculate pseudo p-values instead of exact values.
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
136
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
137 IMPORTANT
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
138 =========
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
139
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
140 For meaningful p-values, the parameters used during bootstrapped correlation estimation (**iterations, exclude iterations, threshold**) should be identical to those used in the original FastSpar run.
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
141
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
142 Output
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
143 ======
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
144
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
145 - `pvalues.tsv`: A table of empirical p-values for all pairwise correlations.
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
146
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
147 When "Recalculate the correlation matrix" is selected the tool will also output:
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
148
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
149 - `median_correlation.tsv`: Correlation matrix between all OTUs.
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
150 - `median_covariance.tsv`: Covariance matrix between all OTUs.
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
151
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
152 Additional Resources
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
153 ====================
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
154
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
155 - FastSpar GitHub: https://github.com/scwatts/fastspar
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
156 ]]></help>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
157 <expand macro="citations"/>
7ff1304e12aa planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/fastspar commit 0e305d21d0634a1788b9105ec4d0ab1c2da62359
iuc
parents:
diff changeset
158 </tool>