generate_report_cmahalanobis: Generate a Microsoft Word document about the Mahalanobis...

In cmahalanobis: Calculate Distance Measures for DataFrames

Generate a Microsoft Word document about the Mahalanobis distances matrix or matrices and the p-values matrix or matrices.

Description

This function takes a dataframe, a factor or factors (two or more) and returns a Microsoft Word document about the Mahalanobis distances matrix or matrices (two or more) and the p-values matrix or matrices.

Usage

generate_report_cmahalanobis(
  dataset,
  formula,
  pvalue.method = "permutation",
  seed = NULL,
  min_group_size = 3,
  pvalues_chisq = FALSE
)

Arguments

dataset	A dataframe.
formula	A variable or variables (two or more) with factors which you want to calculate the Mahalanobis distances matrix or matrices (two or more) and the p_values matrix or matrices (two or more).
pvalue.method	A p_value method used to calculate the matrix or matrices (two or more), the default value is "permutation". Another method is "bootstrap".
seed	Optionally, set a seed for "bootstrap" or "permutation".
min_group_size	Minimum group size to maintain. The default value is 3,therefore groups, inside variables, with less than 3 observations will be discarded.
pvalues_chisq	If TRUE, print the result of the chi-squared test on squared distances. The resulting distances with "pvalues_chisq = FALSE" are not squared; instead, with "pvalues_chisq = TRUE", the squared Mahalanobis distance matrix with corresponding p_values will be printed. Default is FALSE.

Value

A Microsoft Word document about the Mahalanobis distances matrix or matrices (two or more) and the p_values matrix or matrices (two or more).

Examples

# Example with iris dataset
data(iris)

# Generate a report about the "Species" 
# factor in the iris dataset using the "permutation" method.
generate_report_cmahalanobis(iris, ~Species, min_group_size = 3)

# Example with mtcars dataset
data(mtcars)

# Generate a report about the "am" and "vs" in mtcars using "bootstrap" method.
generate_report_cmahalanobis(mtcars, ~am + vs,
pvalue.method = "bootstrap",
seed = 100, min_group_size = 2)
 

cmahalanobis documentation built on Sept. 14, 2025, 5:09 p.m.