cmahalanobis (version 0.5.0)

generate_report_csorensendice: Generate a Microsoft Word document about the Sorensen-Dice distance matrix and the p-values matrix with corresponding plots.

Description

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

Usage

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

Value

A Microsoft Word document about the Sorensen-Dice distance matrix and the p_values matrix.

Arguments

dataset

A dataframe.

formula

A factor which you want to calculate the Sorensen-Dice distance matrix and the p_values matrix.

pvalue.method

A p_value method used to calculate the matrix, the default value is "chisq". Other methods are "permutation" and "bootstrap".

num.permutations

Number of permutation to specify if you select "permutation" in "pvalue.method". The default value is 100.

num.bootstraps

Number of bootstrap to specify if you select "bootstrap" in "p_value method". The default value is 10.

Examples

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

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