SummarizeMultiToolsMultiDatasetsExtr: Internal function to summarizing signature extraction...

In WuyangFF95/SynSigEval: Evaluate Results of Mutational Signature Analysis Software on Synthetic Spectra Created by Package SynSigGen

Internal function to summarizing signature extraction measure.

Description

Summarize results of mutational signature extraction by multiple computational approaches on multiple datasets. Before running this function, make sure the summary file for each single data set toolSummaryPaths/OneToolSummary.Rda exists.

Usage

SummarizeMultiToolsMultiDatasetsExtr(
  toolSummaryPaths,
  out.dir,
  display.datasetName = FALSE,
  sort.by.composite.extraction.measure = "descending",
  overwrite = FALSE
)

Arguments

toolSummaryPaths	Paths of top-level dataset directories trees you want to investigate. E.g. "./S.0.1.Rsq.0.1" Note: OneToolSummary.RDa are expected to be exist under toolSummaryPaths.
out.dir	Path of the output directory.
display.datasetName	Whether to put the name of spectra datasets inside of the csv outputs of summary tables.
sort.by.composite.extraction.measure	Whether to re-order the computational approaches on violin plots, based on the mean of composite measure. "descending": Put the computational approach with the highest mean composite measure to the left, and arrange approaches in descending order. "ascending": Put the computational approach with the lowest mean composite measure to the left, and arrange approaches in ascending order. Anything else: Keep the computational approaches in a smart alphabetical order embedded with numbers, defined by mixedsort.
overwrite	Whether to overwrite the contents in out.dir if it already exists. (Default: FALSE)

Details

OneToolSummary.Rda is generated by SummarizeOneToolMultiDatasets).

WuyangFF95/SynSigEval documentation built on Sept. 18, 2022, 11:41 a.m.