Skip to contents

Sample correlation matrix

Source: R/sample_correlation_matrix.R
sample_correlation_matrix.Rd

This function samples a correlation matrix by sampling a covariance matrix from an inverse Wishart distribution and transforming it to a correlation matrix.

Usage

sample_correlation_matrix(dim, df = dim, scale = diag(dim))

Arguments

dim

[integer(1)]
The dimension.

df

[integer(1)]
The degrees of freedom of the inverse Wishart distribution greater or equal dim.

scale

[matrix()]
The scale covariance matrix of the inverse Wishart distribution of dimension dim.

Value

A correlation matrix.

See also

Other matrix helpers: check_correlation_matrix(), check_covariance_matrix(), check_one_hot_matrix(), check_transition_probability_matrix(), cov_to_chol(), diff_cov(), insert_matrix_column(), matrix_diagonal_indices(), matrix_indices(), sample_covariance_matrix(), sample_transition_probability_matrix(), stationary_distribution()

Examples

sample_correlation_matrix(dim = 3)
#>            [,1]       [,2]       [,3]
#> [1,]  1.0000000  0.7332380 -0.9400451
#> [2,]  0.7332380  1.0000000 -0.7891391
#> [3,] -0.9400451 -0.7891391  1.0000000