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

In cmahalanobis: Calculate Distance Measures for a Given List of Data Frames with Factors

Generate a Microsoft Word document about Mahalanobis distance matrix and p-values matrix with corresponding plots.

Description

This function takes a dataframe, a factor and returns a Microsoft Word document about Mahalanobis distance matrix and p-values matrix with corresponding plots.

Usage

generate_report_cmahalanobis(
  dataset,
  formula,
  pvalue.method = "chisq",
  num.permutations = 10,
  num.bootstraps = 10
)

Arguments

dataset	A dataframe.
formula	A factor which you want to calculate Mahalanobis distances matrix and p_values matrix.
pvalue.method	A method with which you want to calculate pvalue matrix.The default method is "chisq". Other methods are "permutation" and "bootstrap".
num.permutations	A number of permutations to define if you choose "permutation".
num.bootstraps	A number of bootstrap to define if you choose "bootstrap".

Value

A Microsoft Word document about Mahalanobis distances matrix and p_values matrix.

Examples

# Generate a report about "Species" factor in iris dataset
generate_report_cmahalanobis(iris, ~Species)

# Generate a report about "am" factor in mtcars dataset
generate_report_cmahalanobis(mtcars, ~am)

cmahalanobis documentation built on April 3, 2025, 8:51 p.m.