mat_link: Link matrix specification

Description Usage Arguments Details Value Author(s)

View source: R/mat_link.R

Description

Specifies the link matrix corresponding to a particular analysis model.

Usage

1
mat_link(D = 4, model = 1, prop = 0.5, placebos = 1, summary = T)

Arguments

D

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

model

A single numeric integer between one and nine inclusive, specifying which model to compute the row-column design for. See Details for further information. Defaults to 1.

prop

Only used when model = 3, when it should be a single numeric describing the proportionality parameter.

placebos

Only used when model = 4, when it should be a single numeric integer between zero and D - 1 inclusive, describing the number of placebos in the trial.

summary

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

Details

mat_link() supports the specification of link matrices. Precisely, a number of treatments (see D) and a chosen model (see model) are specified. The link matrix for use in computing design matrices is then returned. The value of model must be an integer between one and nine inclusive, corresponding to the following models:

See the package vignette for further details on these models.

Value

A matrix detailing the determined link matrix.

Author(s)

Based on code from the Crossover package by Kornelius Rohmeyer.


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