seq_latin: Latin square cross-over design specification

Description Usage Arguments Details Value References Examples

View source: R/seq_latin.R

Description

Specifies Latin square cross-over designs.

Usage

1
seq_latin(D = 2, 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 three. Defaults to 2.

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_latin() supports the specification of Latin square designs. Designs for any number of 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.

References

Bailey RA (2008) Design of Comparative Experiments. Cambridge University Press: Cambridge.

Jones B, Kenward MG (2014) Design and Analysis of Cross-Over Trials. Chapman and Hall: London, 3rd Edition.

Examples

1
2
3
4
5
6
# A Latin square for the default parameters
latin        <- seq_latin()
# Using different labels
latin_AB     <- seq_latin(labels = LETTERS[1:2])
# Returning in tibble form
latin_tibble <- seq_latin(as_matrix = F)

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