GenerateSynAbstract: Generate synthetic exposures from abstract parameters.

View source: R/CreateSynData.R

GenerateSynAbstractR Documentation

Generate synthetic exposures from abstract parameters.

Description

Checkpoints the parameters and the synthetic exposures to files. It also checks that the parameters inferred from the synthetic data approximate those inferred from real.exp.

Usage

GenerateSynAbstract(
  parms,
  num.syn.tumors,
  file.prefix = NULL,
  sample.id.prefix,
  froot = NULL,
  round.exposure = FALSE
)

Arguments

parms

The actual exposures upon which to base the parameters and synthetic exposures.

num.syn.tumors

Generate this number of synthetic tumors.

file.prefix

Prepend this to output filenames to indicate the organization of the data.

sample.id.prefix

Prefix for sample identifiers for the synthetic samples.

round.exposure

Whether the exposures should be rounded to an integer. Set as FALSE only when reproducing legacy data sets.

Value

A list with elements:

  1. parms The parameters inferred from real.exp.

  2. syn.exp The synthetic exposures generated from parms.


steverozen/SynSigGen documentation built on April 1, 2022, 8:54 p.m.