StrBCD.ui {carat}R Documentation

Command-line User Interface Using Shao's Method

Description

A call to the user-interface function used to allocate patients to one of two treatments using Shao's method proposed by Shao J, Yu X, Zhong B (2010) <doi:10.1093/biomet/asq014>.

Usage

StrBCD.ui(path, folder = "StrBCD")

Arguments

path

the path in which a folder used to storage variables will be created.

folder

name of the folder. If default, a folder named "StrBCD" will be created.

Details

See StrBCD.

Value

It returns an object of class "carseq".

The function print is used to obtain results. The generic accessor functions assignment, covariate, cov_num, cov_profile and others extract various useful features of the value returned by StrBCD.ui.

Note

This function provides a command-line interface and users should follow the prompts to enter data including covariates as well as levels for each covariate, biased probability p and the covariate profile of the new patient.

References

Shao J, Yu X, Zhong B. A theory for testing hypotheses under covariate-adaptive randomization[J]. Biometrika, 2010, 97(2): 347-360.

See Also

See StrBCD for allocating patients with complete covariate data; See StrBCD.sim for allocating patients with covariate data generating mechanism.


[Package carat version 2.0.2 Index]