small change: additional stat summary

openpharma · Sep 1, 2023 · 2ff5275 · 2ff5275
1 parent 4940312
commit 2ff5275
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 6 deletions.
diff --git a/R/Design-methods.R b/R/Design-methods.R
@@ -190,7 +190,9 @@ getResultList <- function(fun,
 ##' @param nCores how many cores should be used for parallel computing?
 ##' Defaults to the number of cores on the machine, maximum 5.
 ##' @param \dots not used
-##' @param derive A list of functions that derive statistics from the target dose samples.
+##' @param derive a list of functions which derives statistics, based on the
+##' vector of posterior MTD samples. Each list element must therefore accept
+##' one and only one argument, which is a numeric vector, and return a number.
 ##'
 ##' @return an object of class \code{\linkS4class{Simulations}}
 ##'
@@ -706,7 +708,9 @@ setMethod("simulate",
 ##' @param nCores how many cores should be used for parallel computing?
 ##' Defaults to the number of cores on the machine, maximum 5.
 ##' @param \dots not used
-##' @param derive A list of functions that derive statistics from the target dose samples.
+##' @param derive a list of functions which derives statistics, based on the
+##' vector of posterior MTD samples. Each list element must therefore accept
+##' one and only one argument, which is a numeric vector, and return a number.
 ##'
 ##' @return an object of class \code{\linkS4class{DualSimulations}}
 ##'
@@ -4179,7 +4183,9 @@ setMethod("simulate",
 ##' @param nCores how many cores should be used for parallel computing?
 ##' Defaults to the number of cores on the machine (maximum 5)
 ##' @param \dots not used
-##' @param derive A list of functions that derive statistics from the target dose samples.
+##' @param derive a list of functions which derives statistics, based on the
+##' vector of posterior MTD samples. Each list element must therefore accept
+##' one and only one argument, which is a numeric vector, and return a number.
 ##'
 ##' @return an object of class \code{\linkS4class{Simulations}}
 ##'

diff --git a/man/simulate-DADesign-method.Rd b/man/simulate-DADesign-method.Rd
diff --git a/man/simulate-Design-method.Rd b/man/simulate-Design-method.Rd
diff --git a/man/simulate-DualDesign-method.Rd b/man/simulate-DualDesign-method.Rd