ectdColNames: Control of default column names

In MSToolkit: The MSToolkit library for clinical trial design

Description

Functions that allow control over the default column names for simulated data

Usage

getEctdColName(colName) 
setEctdColName(colName, Value) 
getEctdPossibleColNames(colName) 
setEctdPossibleColNames(colName, Value) 
resetEctdColNames(whichNames = names(getNames)) 
matchEctdColNames(colName, dataNames)

Arguments

colName	(Required) The "column type" of the variable name of interest (one of 'Subject', 'Time', 'Dose', 'Interim', 'ParOmit', 'RespOmit', 'Response', 'Trt', 'Missing', 'Replicate', 'DrugName' and 'Drug')
Value	(Required) Value to which to set the default column name
dataNames	(Required) Column names against which to match the possible set of column names
whichNames	Column types for which to reset the default name (default all)

Details

The functions provide the following capabilities: * getEctdColName - Gets the current default column name given a column type * setEctdColName - Sets the current default column name for a column type * resetEctdColNames - Resets the current default column names to their initial state * getEctdPossibleColNames - Gets the set of possible column names given a column type * setEctdPossibleColNames - Sets the set of possible column names given a column type * matchEctdColNames - Selects a column name from a set of names that best matches the possible column type names

The set of possible "column types" are: * Subject - Subject column * Dose - Dose column * Time - Time column * Replicate - Replicate column names * Interim - Interim allocation column name * ParOmit - Parameter "omit" flag column name * RespOmit - Response "omit" flag column name * Response - Response column name * Trt - Treatment column name * Missing - Parameter "omit" flag column name * DrugName - Name of column containing the "Drug Name" (used in typical value simulations) * Drug - Name of column containing the "Drug Value" (used in typical value simulations)

Value

The "getEctdColName" function returns a single character, giving the current column name

The "getEctdPossibleColNames" function returns a character vector, giving a set of possible columns

The "matchEctdColNames" function returns a single character identifying the variable in "dataNames" that should be used as the "colName" column

The other functions to not explicitly return anything

Author(s)

Mike K Smith [e-mail]

Examples

## Not run: 
	getEctdColName("Subject")
	setEctdColName("Subject", "ID")
	getEctdColName("Subject")	
	resetEctdColNames()		
	getEctdPossibleColNames("Subject")
	matchEctdColNames ("Subject", c("A", "SUBJ", "B"))

## End(Not run)

MSToolkit documentation built on May 2, 2019, 6:30 p.m.