getProbData: getProbData

In eniclas/FAIRsimulator: Simulation Platform for the FAIR Trial

Description

Extracts the randomization probabilities from all cohorts over time.

Usage

getProbData(StudyObj, strProb = "UnWeightedRandomizationProbabilities",
  iter = NULL, ...)

Arguments

StudyObj	A FAIRsimulator study object
strProb	A string indicating the probabilities to extract. Possible values are "UnWeightedRandomizationProbabilities" and "RandomizationProbabilities". The former are the probabilities after adjustment for minimum allocation probabilities and the latter are the unadjusted probabilities.
...	Other parameters passed to getCohortAgeRange

Value

A data.frame with columns CohortName (cohort name), Prob (probability), TreatmentName, CohortAge (cohort age group label) and RandStudyTime (the time the randomisation probabilities were set).

Examples

## Not run: 
probData <- getProbData(StudyObj)

## End(Not run)

eniclas/FAIRsimulator documentation built on May 16, 2019, 5:12 a.m.