seq_balaam: Balaam (1968) cross-over design specification

Description Usage Arguments Details Value Author(s) References Examples

View source: R/seq_balaam.R

Description

Specifies cross-over designs from Balaam (1968).

Usage

1
seq_balaam(D = 3, labels = 0:(D - 1), as_matrix = T, summary = T)

Arguments

D

The number of treatments. Must be a single numeric integer greater than or equal to two. Defaults to 3.

labels

A vector of labels for the treatments. Should be of length D, containing unique elements. Defaults to 0:(D - 1).

as_matrix

A logical variable indicating whether the design should be returned as a matrix, or a tibble. Defaults to T.

summary

A logical variable indicating whether a summary of the function's progress should be printed to the console. Defaults to T.

Details

seq_balaam() supports the specification of cross-over designs from Balaam (1968). Designs for three through six treatments (see D) are supported, for any chosen treatment labels (see labels). In addition, the designs can be returned in matrix or tibble form (see as_matrix).

Precisely, the (k,j)th element of the cross-over design matrix corresponds to the treatment a subject on the kth sequence would receive in the jth period.

Value

Either a matrix if as_matrix = T (with rows corresponding to sequences and columns to periods), or a tibble if as_matrix = F (with rows corresponding to a particular period on a particular sequence). In either case, the returned object will have class xover_seq.

Author(s)

Based on data from the Crossover package by Kornelius Rohmeyer.

References

Balaam LN (1968) A two-period design with t² experimental units. Biometrics 24:61-73.

Examples

1
2
3
4
5
6
# Balaam (1968) design for three treatments
balaam        <- seq_balaam()
# Using different labels
balaam_ABC    <- seq_balaam(labels = LETTERS[1:3])
# Returning in tibble form
balaam_tibble <- seq_balaam(as_matrix = F)

mjg211/xover documentation built on Oct. 16, 2019, 10:46 a.m.