seq_all: Supported cross-over designs

Description Usage Arguments Details Value Examples

View source: R/seq_all.R

Description

Determine the cross-over designs supported by the seq_#() functions in xover.

Usage

1
seq_all(D = 2, J = 2, K = 2, summary = T)

Arguments

D

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

J

The number of periods. Must be a numeric vector of integers, whose values are greater than or equal to two. Defaults to 2.

K

The number of sequences. Must be a numeric vector of integers, whose values are greater than or equal to two. Defaults to 2.

summary

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

Details

seq_all() supports the determination of the cross-over designs supported by the seq_#() functions in xover for a specified number of treatments (see D), periods (see J), and sequences (see K).

Value

If at least one supported design is identified for the chosen input parameters, a tibble describing the supported sequences. Otherwise, it will be NULL. In either case, the returned object will have class xover_seq.

Examples

1
2
3
4
5
6
7
8
9
# Available sequences for three-treatment three-period trials with between
# two and 20 sequences
three_by_three        <- seq_all(D = 3, J = 3, K = 2:20)
# Available sequences for three-treatment two-period trials with between
# two and 20 sequences
three_by_two          <- seq_all(D = 3, J = 2, K = 2:20)
# Available sequences for three-treatment two- or three-period trials with
between two and 20 sequences
three_by_two_or_three <- seq_all(D = 3, J = c(2, 3), K = 2:20)

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