genMixFormula: Generate Mixture Formula
In simstudy: Simulation of Study Data

genMixFormula

R Documentation

Generate Mixture Formula

Description

Generates a mixture formula from a vector of variable names and an optional vector of probabilities.

Usage

genMixFormula(vars, probs = NULL, varLength = NULL)

Arguments

`vars`	Character vector/list of variable names.
`probs`	Numeric vector/list of probabilities. Has to be same length as vars or NULL. Probabilities will be normalized if the sum to > 1.
`varLength`	If `vars` is of length one and varLength is set to any integer > 0, `vars` will be interpreted as array of length `varLength` and all elements will used in sequence.

Value

The mixture formula as a string.

Examples

genMixFormula(c("a", "..b[..i]", "c"))
genMixFormula(c("a", "..b", "c"), c(.2, .5, .3))

# Shorthand to use external vectors/lists
genMixFormula("..arr", varLength = 5)

simstudy documentation built on Nov. 23, 2023, 1:06 a.m.