adjust_corr_mtr: Adjust correlation matrix

View source: R/S4-Correlation.R

adjust_corr_mtrR Documentation

Adjust correlation matrix

Description

Adjust correlation matrix

Usage

adjust_corr_mtr(mtr, type = "complete", diagonal = TRUE)

Arguments

mtr

Correlation or p-value matrix.

type

Character value. Denotes how the underlying correlation matrix is handled. Three options:

  • 'complete': The matrix stays as is.,

  • 'lower': The part below the diagonal is used. The upper part is set to NA.,

  • 'upper':The part above the diagonal is used. the lower part is set to NA.

diagonal

Logical value. Indicates if the diagonal values of the matrices are kept ( = TRUE) or set to NA (= FALSE). Ignored if type = 'complete'.

Value

Adjusted input matrix.


kueckelj/confuns documentation built on July 4, 2024, 4:53 p.m.