lib5c.writers.correlation module

Module for writing pairwise correlation matrices to text files.

lib5c.writers.correlation.write_correlation_table(correlation_matrix, outfile, labels=None, sep=', ')[source]

Write a pairwise correlation matrix to a text file.

Parameters

  • correlation_matrix (np.ndarray) – The pairwise correlation matrix to write.

  • outfile (str) – String reference to the file to write to.

  • labels (Optional[List[str]]) – Pass a list of strings equal to the number of rows/columns in the correlation_matrix to label the rows and columns in the output file with these labels in the headers.

  • sep (str) – The separator to use to separate columns in the written text file.