DataOrdinal-class | R Documentation |
DataOrdinal
DataOrdinal
is a class for ordinal toxicity data.
It inherits from GeneralData
and it describes toxicity responses on an
ordinal rather than binary scale.
DataOrdinal(
x = numeric(),
y = integer(),
ID = integer(),
cohort = integer(),
doseGrid = numeric(),
placebo = FALSE,
yCategories = c(`No DLT` = 0L, DLT = 1L),
...
)
.DefaultDataOrdinal()
x |
( |
y |
( |
ID |
( |
cohort |
( |
doseGrid |
( |
placebo |
( |
yCategories |
(named |
... |
not used. |
The cohort
can be missing if and only if placebo
is equal to
FALSE
.
This class has been implemented as a sibling of the existing Data
class
(rather than as a parent or child) to minimise the risk of unintended side
effects on existing classes and methods.
The default setting for the yCategories
slot replicates the behaviour
of the existing Data
class.
Typically, end users will not use the .DefaultDataOrdinal()
function.
DataOrdinal(
x = c(10, 20, 30, 40, 50, 50, 50, 60, 60, 60),
y = as.integer(c(0, 0, 0, 0, 0, 1, 0, 0, 1, 2)),
ID = 1L:10L,
cohort = as.integer(c(1:4, 5, 5, 5, 6, 6, 6)),
doseGrid = c(seq(from = 10, to = 100, by = 10)),
yCategories = c("No tox" = 0L, "Sub-tox AE" = 1L, "DLT" = 2L),
placebo = FALSE
)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.