Skip to contents

Visualize Covariance Matrix at a Specific Bin

Source: R/checkRes_covMtx.R
checkRes_covMtx.Rd

This function generates a heatmap of the covariance matrix at a specified bin index from a result object Res. The heatmap uses a customizable color gradient and overlays numeric values on each cell.

Usage

checkRes_covMtx(
  Res,
  bin = 1,
  min = -1,
  mid = 0,
  max = 1,
  mincolor = "blue",
  midcolor = "white",
  maxcolor = "red"
)

Arguments

Res

A Res object containing the following components:

  • cov_matrices: A 3D array of covariance matrices (detector x detector x bin).

  • detectors: A character vector of detector names.

  • bin_mids: A numeric vector of bin midpoints.

  • id: An identifier for the result object, used in the plot title.

bin

Integer index specifying which bin's covariance matrix to visualize. Default is 1 (the first bin).

min

Minimum value for the color scale. Default is -1.

mid

Midpoint value for the color scale. Default is 0.

max

Maximum value for the color scale. Default is 1.

mincolor

Color corresponding to the minimum value. Default is "blue".

midcolor

Color corresponding to the midpoint value. Default is "white".

maxcolor

Color corresponding to the maximum value. Default is "red".

Value

A Heatmap object from the ComplexHeatmap package, visualizing the covariance matrix.

Examples

if (FALSE) { # \dontrun{
  checkRes_covMtx(Res, bin = 2)
} # }