randotools (version 0.2.4)

summary.randolist: Summary method fro randolist objects

Description

Create a short summary report of the aspects of the randomisation list, which could be used for quality control.

Usage

# S3 method for randolist
summary(object, ...)

Value

object of class randolistsum, which is a list with elements

• n_rando: total number of randomisations

• n_blocks: maximum number of blocks

• block_sizes: table of block sizes

• arms: table of arms

• ratio: randomisation ratio (character)

• stratified: logical

• stratavars: names of stratifying variables (character)

• stratavars_tabs: tabulation of arms by each stratifcation variable

• strata: names of each individual stratum

• stratum_tabs: list with an element for each strata with n_rando, n_blocks, block_sizes, arms and ratio.

Arguments

object

randolist object

...

additional arguments (currently unused)

Examples

r <- randolist(20)
print(summary(r))

r2 <- randolist(20, strata = list(sex = c("M", "F")))
print(summary(r2))

# NOTE: explicitly printing isn't technically necessary