imbalance: Treatment Imbalance

View source: R/trialMinRand.R

imbalanceR Documentation

Treatment Imbalance

Description

Provides a measure of treatment imbalance with respect to a desired ratio of treatments.

Usage

imbalance(treatments, treatment.ratios)

Arguments

treatments

a factor or a character/numeric vector containing a sequence of treatments.

treatment.ratios

a named vector containing the desired treatment ratios. Treatment.ratios should at least contain all unique elements of the treatments vector.

Details

A treatment vector has imbalance 0 if the treatments occur in the desired ratio. Otherwise, the imbalance is positive.

Examples

# A balanced treatment vector
imbalance(factor(c("A","B","B","A"),levels=c("A","B")),treatment.ratios=c(A=1,B=1))
# Still balanced if ratio is given as 50:50 instead of 1:1
imbalance(factor(c("A","B","B","A"),levels=c("A","B")),treatment.ratios=c(A=50,B=50))
# Treatments can also be provided as a numeric vector
imbalance(c(1,2,2,1),treatment.ratios=c("1"=1,"2"=1))
# Treatments can be provided as a character vector
imbalance(c("A","B","B","A"), treatment.ratios=c(A=1,B=1))


jtextor/trialMinRand documentation built on July 29, 2023, 8:59 a.m.