Retrieve Cluster Percentage Data and Stats

This function retrieves the cluster percentage data from a TockyPrepData that has already been processed with the PlotClusterPercentage function. It can display the statistics in the Terminal or write them to CSV files.

Usage

GetStatsClusterPercentage(
  x,
  writeResults = FALSE,
  filename = "cluster_percentage"
)

Arguments

x

A TockyPrepData that has been processed with the PlotClusterPercentage function.

writeResults

A logical value. If TRUE, two files will be generated containing group statistics and p-values, respectively. If FALSE, these statistical results are displayed in the Terminal.

filename

(optional) Base name for the output files when writeResults is TRUE.

Value

The same TockyPrepData passed as input, for consistency in function design, though the function primarily focuses on data retrieval and display or file writing.

Examples

if (FALSE) { # \dontrun{
  GetStatsClusterPercentage(x)
} # }