import_cor_matrix: Import a correlation matrix

View source: R/synthesise_data.R

import_cor_matrixR Documentation

Import a correlation matrix

Description

Imports a correlation matrix from a csv file generated by export_empty_cor_matrix

Usage

import_cor_matrix(file_path = "./correlation_matrix.csv")

Arguments

file_path

A path to the csv file, Default: './correlation_matrix.csv'

Details

A function to import the user specified correlations generated from the csv file exported by the export_empty_cor_matrix function. Correlations should be entered into the CSV file, using rank order correlations. The correlation matrix should be symmetric and be positive semi definite.

Value

a matrix of correlations that can be used with synthesise_data

See Also

export_empty_cor_matrix is.positive.semi.definite

Examples

## Not run: 
  import_cor_matrix("correlation_matrix.csv")

## End(Not run)

RESIDE documentation built on Oct. 18, 2024, 1:07 a.m.