combat_table_gen {ComBatFamQC} | R Documentation |
Generate Diagnostic Tables for Batch Effect Analysis
Description
This function generates a variety of tables to summarize data and results from batch effect analyses. Depending on the specified table name, it can create data overview tables, exploratory analysis summaries, statistical test results, PCA summaries, and covariate distributions.
Usage
combat_table_gen(
result,
table_name,
f = NULL,
c = NULL,
PC1 = NULL,
PC2 = NULL
)
Arguments
result |
A list derived from |
table_name |
A string specifying the type of table to generate. Options include:
|
f |
A string specifying the feature of interest for tables requiring a specific feature. Default is |
c |
A string specifying the covariate of interest for tables requiring a specific covariate. Default is |
PC1 |
A string specifying the first principal component for PCA variance tables. Default is |
PC2 |
A string specifying the second principal component for PCA variance tables. Default is |
Details
The function dynamically generates tables based on the table_name
parameter.
Value
A DT::datatable
object containing the requested table.
Examples
if(interactive()){
result <- visual_prep(type = "lm", features = "thickness.left.cuneus",
batch = "manufac", covariates = "AGE", df = adni[1:100, ], mdmr = FALSE, cores = 1)
combat_table_gen(result, table_name = "cov_table", c = "AGE")
combat_table_gen(result, table_name = "pc_variance", PC1 = "PC1", PC2 = "PC2")
}