evaluatePerformanceExposuresList: evaluate performance exposures list

In Nik-Zainal-Group/signature.tools.lib: signature.tools.lib

evaluate performance exposures list

Description

Compare an exposure matrix with the true exposures with a list of estimated exposure matrices, and compute various metrics to determine how well the estimated exposures match the true exposures. If the names of common and/or rare mutational signatures are provided, then the metrics are calculated separately for common and rare signatures. Results are plotted to a file if outfile is specified.

Usage

evaluatePerformanceExposuresList(
  true_exposures,
  estimated_exposures_list,
  commonNames = NULL,
  rareNames = NULL,
  outfile = NULL
)

Arguments

true_exposures	matrix of true exposures, for example obtained using simulations, with mutational signatures names as colnames and sample names as rownames
estimated_exposures_list	list of matrices of estimated exposures, for example obtained using a signature extraction or fit algorithm on a simulated dataset, with mutational signatures names as colnames and sample names as rownames. Use a named list, so that the names can be used in he data structure returned and plots.
commonNames	names of common mutational signatures. If NULL, all signatures in the colnames of true_exposures and estimated_exposures will be used
rareNames	names of rare mutational signatures. If NULL, rare signatures metrics will not be computed. This is ok if the simulated data didn't have any rare signatures.
outfile	file name for plotting, please use .pdf file name extension. Can be omitted.

Value

performance metrics

Nik-Zainal-Group/signature.tools.lib documentation built on April 13, 2025, 5:50 p.m.