annotate mmuphin.xml @ 1:23d58581f349 draft default tip

planemo upload for repository https://github.com/biobakery/MMUPHin commit 85ea7462e2b824c35b9d444f6dfced71e990a412
author iuc
date Fri, 16 May 2025 12:56:52 +0000
parents 3938766e5135
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
1 <tool id="mmuphin" name="mmuphin" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
2 <description>Performing meta-analyses of microbiome studies</description>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
3 <macros>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
4 <import>macros.xml</import>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
5 </macros>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
6 <expand macro="xrefs"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
7 <expand macro="requirements"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
9 Rscript '$rscript' &&
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
10 mv 'adjust_batch_diagnostic.pdf' '$diagnostic_plot_output'
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
11 ]]></command>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
12
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
13 <configfiles>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
14 <configfile name="rscript"><![CDATA[
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
15
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
16 library(MMUPHin)
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
17
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
18 ## input files
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
19 print("Read input files")
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
20 data <- read.csv("$input_data", sep = "\t", row.names=1, check.names = FALSE)
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
21 meta_data <- read.csv("$input_metadata", sep = "\t", row.names=1, check.names = FALSE)
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
22
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
23 # Define control list
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
24 controls <- list("$additional_options.zero_inflation",
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
25 "$additional_options.pseudo_count",
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
26 "$additional_options.conv",
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
27 "$additional_options.maxit",
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
28 "$additional_options.verbose",
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
29 "$additional_options.diagnostic_plot")
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
30
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
31 #Perform batch adjustment
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
32
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
33 # Convert the batch column in the data frame to character or factor
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
34
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
35 batch <- colnames(meta_data[$batch_input - 1]) # Adjust to fetch the column name
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
36 meta_data[[batch]] <- as.factor(meta_data[[batch]]) # Convert the column to factor
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
37 cat("Batch Name:", unique(meta_data[[batch]]), "\n") # Print unique batch names for confirmation
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
38 cat("Batch Name:", batch, "\n")
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
39
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
40 ## handle the optional command line input
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
41 #if $covariates_input:
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
42 covariates_val <- list($covariates_input)
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
43 #else:
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
44 covariates_val <- list() # Assign an empty list if input is NULL or does not exist
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
45 #end if
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
46
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
47 covariates <- c()
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
48
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
49 # Process covariates only if they exist
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
50 if (length(covariates_val) > 0) {
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
51 for (i in covariates_val) {
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
52 covariates <- c(covariates, colnames(meta_data[i - 1]))
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
53 }
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
54 cat("Covariates Names:", covariates, "\n")
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
55 } else {
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
56 cat("No covariates provided.\n")
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
57 }
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
58
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
59 result <- adjust_batch(feature_abd = data,
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
60 batch = batch,
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
61 covariates = covariates,
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
62 data = meta_data,
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
63 control=controls
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
64 )
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
65
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
66 # Save results into output files
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
67
1
23d58581f349 planemo upload for repository https://github.com/biobakery/MMUPHin commit 85ea7462e2b824c35b9d444f6dfced71e990a412
iuc
parents: 0
diff changeset
68 write.table(result\$feature_abd_adj, file="$output", quote = FALSE, sep="\t", col.names=NA)
23d58581f349 planemo upload for repository https://github.com/biobakery/MMUPHin commit 85ea7462e2b824c35b9d444f6dfced71e990a412
iuc
parents: 0
diff changeset
69
0
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
70 ]]></configfile>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
71 </configfiles>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
72
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
73 <inputs>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
74 <param name="input_data" type="data" format="tabular" label="Abundance (or features) file" help="TSV file where columns represent samples and rows include abundance values for features such as taxa, genes, or other biological entities across those samples."/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
75 <param name="input_metadata" type="data" format="tabular" label="Metadata file" help="TSV file with sample metadata, where columns represent attributes and rows include attribute values for a sample"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
76 <param argument="batch_input" type="data_column" data_ref="input_metadata" use_header_names="true" label="Batch identifier column" help="Select the column in your metadata file that contains the batch identifier (e.g., studyID, batchID) used to group samples for batch correction."/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
77 <param argument="covariates_input" type="data_column" data_ref="input_metadata" use_header_names="true" multiple="true" optional="true" label="Covariates Column(s)" help="Select the column(s) in your metadata file that contain covariates (e.g., age, gender, or environmental factors) to be included in the batch correction process." />
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
78 <section name="additional_options" title="Additional Options" expanded="true">
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
79 <param argument="zero_inflation" type="boolean" truevalue="zero_inflation TRUE" falsevalue="zero_inflation FALSE" checked="true" label="Run zero-inflated model"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
80 <param argument="pseudo_count" type="float" optional="true" label="Pseudo_count" help="Pseudo count to add feature_abd before the methods' log transformation. Default to the half of the minimal non-zero values in feature_abd" />
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
81 <param argument="conv" type="float" value="0.0001" min="0.000001" max="0.001" optional="true" label="Convergence threshold" help="Convergence threshold for the method's iterative algorithm for shrinking batch effect parameters."/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
82 <param argument="maxit" type="float" optional="true" value="1000" label="Maximum number of iterations" help="Maximum number of iterations allowed for the method's iterative algorithm. Default to 1000"/>
1
23d58581f349 planemo upload for repository https://github.com/biobakery/MMUPHin commit 85ea7462e2b824c35b9d444f6dfced71e990a412
iuc
parents: 0
diff changeset
83 <param argument="verbose" type="hidden" value="False" label="Print verbose information"/>
0
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
84 <param argument="diagnostic_plot" type="boolean" truevalue="diagnostic_plot TRUE" falsevalue="diagnostic_plot FALSE" checked="true" label="Generate diagnostic figure file"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
85 </section>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
86 </inputs>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
87
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
88 <outputs>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
89 <data name="output" format="tabular" label="Adjusted abundance table"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
90 <data name="diagnostic_plot_output" format="pdf" label="diagnostic figure file">
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
91 <filter>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
92 additional_options['diagnostic_plot'] is True
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
93 </filter>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
94 </data>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
95 </outputs>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
96
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
97 <tests>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
98 <test expect_num_outputs="2">
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
99 <param name="input_data" value="CRC_abd.tsv"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
100 <param name="input_metadata" value="CRC_meta.tsv"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
101 <param name="batch_input" value="29"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
102 <param name="covariates_input" value="4"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
103 <section name="additional_options">
1
23d58581f349 planemo upload for repository https://github.com/biobakery/MMUPHin commit 85ea7462e2b824c35b9d444f6dfced71e990a412
iuc
parents: 0
diff changeset
104 <param name="zero_inflation" value="True"/>
0
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
105 <param name="pseudo_count" value="3"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
106 <param name="conv" value="0.0001"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
107 <param name="maxit" value="1000"/>
1
23d58581f349 planemo upload for repository https://github.com/biobakery/MMUPHin commit 85ea7462e2b824c35b9d444f6dfced71e990a412
iuc
parents: 0
diff changeset
108 <param name="diagnostic_plot" value="True"/>
0
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
109 </section>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
110 <output name="output" file="CRC_abd_corrected.tsv" ftype="tabular"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
111 <output name="diagnostic_plot_output" file="diagnostic.pdf" ftype="pdf"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
112 </test>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
113 <test expect_num_outputs="2">
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
114 <param name="input_data" value="CRC_abd.tsv"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
115 <param name="input_metadata" value="CRC_meta.tsv"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
116 <param name="batch_input" value="7"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
117 <section name="additional_options">
1
23d58581f349 planemo upload for repository https://github.com/biobakery/MMUPHin commit 85ea7462e2b824c35b9d444f6dfced71e990a412
iuc
parents: 0
diff changeset
118 <param name="zero_inflation" value="True"/>
0
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
119 <param name="pseudo_count" value="3"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
120 <param name="conv" value="0.0001"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
121 <param name="maxit" value="1000"/>
1
23d58581f349 planemo upload for repository https://github.com/biobakery/MMUPHin commit 85ea7462e2b824c35b9d444f6dfced71e990a412
iuc
parents: 0
diff changeset
122 <param name="diagnostic_plot" value="True"/>
0
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
123 </section>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
124 <output name="output" file="CRC_abd_corrected2.tsv" ftype="tabular"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
125 <output name="diagnostic_plot_output" file="diagnostic2.pdf" ftype="pdf"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
126 </test>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
127 <test expect_num_outputs="2">
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
128 <param name="input_data" value="CRC_abd.tsv"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
129 <param name="input_metadata" value="CRC_meta.tsv"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
130 <param name="batch_input" value="29"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
131 <param name="covariates_input" value="4,6"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
132 <section name="additional_options">
1
23d58581f349 planemo upload for repository https://github.com/biobakery/MMUPHin commit 85ea7462e2b824c35b9d444f6dfced71e990a412
iuc
parents: 0
diff changeset
133 <param name="zero_inflation" value="True"/>
0
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
134 <param name="pseudo_count" value="3"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
135 <param name="conv" value="0.0001"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
136 <param name="maxit" value="1000"/>
1
23d58581f349 planemo upload for repository https://github.com/biobakery/MMUPHin commit 85ea7462e2b824c35b9d444f6dfced71e990a412
iuc
parents: 0
diff changeset
137 <param name="diagnostic_plot" value="True"/>
0
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
138 </section>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
139 <output name="output" file="CRC_abd_corrected3.tsv" ftype="tabular"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
140 <output name="diagnostic_plot_output" file="diagnostic3.pdf" ftype="pdf"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
141 </test>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
142 </tests>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
143 <help><![CDATA[
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
144 @HELP_HEADER@
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
145 MmuPHin
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
146 =========
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
147 MMUPHin is an R package implementing meta-analysis methods for microbial community profiles. Meta-analysis methods are statistical techniques used to combine and synthesize data from multiple independent studies, typically to derive a more precise or generalizable conclusion. This approach is commonly used in fields such as medicine, psychology, and biology to aggregate research findings and increase the statistical power of analyses by pooling data from different experiments or studies. MMUPHin has interface for:
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
148
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
149 Performing batch effect adjustment :
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
150 ------------------------------------------------------------------
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
151 It aims to correct for technical batch effects in microbial feature abundances. Batch effects refer to variations in data that arise not from the biological or experimental variables of interest but due to differences in technical or procedural factors during data collection or processing. For example:
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
152
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
153 Different equipment or lab environments.
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
154 Different operators handling the experiment.
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
155 Variations in sample preparation, sequencing runs, or platforms.
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
156
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
157 These unwanted variations can obscure true biological signals and introduce bias, making it critical to adjust for batch effects to ensure accurate and comparable results across datasets.
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
158
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
159 Inputs for batch effect adjustment:
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
160 ======================================
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
161 A feature-by-sample abundance matrix (e.g., microbial abundances).
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
162 A metadata file, which contains information about samples, including batch identifiers and optional covariates.
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
163
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
164 Output:
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
165 =========
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
166 A batch-adjusted abundance matrix for downstream analyses.
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
167 A diagnostic plot output showing change before and after batch correction.
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
168
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
169 ]]></help>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
170 <expand macro="citations"/>
3938766e5135 planemo upload for repository https://github.com/biobakery/MMUPHin commit 9d6123a18805224b03c0558647cd079624886361
iuc
parents:
diff changeset
171 </tool>