SummarizeSigOnehelmsmanSubdir: Assess/evaluate results from helmsman.NMF

View source: R/SummarizeResultshelmsman.R

SummarizeSigOnehelmsmanSubdirR Documentation

Assess/evaluate results from helmsman.NMF

Description

Assess/evaluate results from helmsman.NMF

Usage

SummarizeSigOnehelmsmanSubdir(
  run.dir,
  ground.truth.exposure.dir = paste0(run.dir, "/../../../"),
  summarize.exp = TRUE,
  overwrite = FALSE
)

Arguments

run.dir

A directory which contains output of helmsman.NMF in one run on a specific dataset, possibly with a specified seed. E.g. 2b.Full_output_K_as_2/helmsman.NMF.results/S.0.1.Rsq.0.1/seed.1/.

This code depends on a conventional directory structure documented in NEWS.md.

ground.truth.exposure.dir

Folder which stores ground-truth exposures. Should contain a file named ground.truth.syn.exposures.csv. In PCAWG paper: run.dir/../../ In SBS1-SBS5 paper: 0.Input_datasets/S.0.1.Rsq.0.1/

summarize.exp

Whether to summarize exposures when the file specified by inferred.exp.path exists.

overwrite

If TRUE overwrite and files in existing run.dir/summary folder.


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