DoptBCD.ui: Command-line User Interface Using Atkinson's D_A-optimal...

View source: R/rand_CLI.R

DoptBCD.uiR Documentation

Command-line User Interface Using Atkinson's D_A-optimal Biased Coin Design

Description

A call to the user-interface function used to allocate patients to one of two treatments using Atkinson's D_A-optimal biased coin design proposed by Atkinson A C (1982) <doi:10.2307/2335853>.

Usage

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

Arguments

path

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

folder

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

Details

See DoptBCD.

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 that function.

Note

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

References

Atkinson A C. Optimum biased coin designs for sequential clinical trials with prognostic factors[J]. Biometrika, 1982, 69(1): 61-67.

Ma W, Ye X, Tu F, Hu F. carat: Covariate-Adaptive Randomization for Clinical Trials[J]. Journal of Statistical Software, 2023, 107(2): 1-47.

See Also

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


carat documentation built on Sept. 8, 2023, 6:05 p.m.