From 2ff52758b0feefcb5984cbc1483460e0bbf3a6fb Mon Sep 17 00:00:00 2001
From: Prerana Chandratre <prerana.chandratre@bayer.com>
Date: Fri, 1 Sep 2023 14:25:02 +0200
Subject: [PATCH] small change: additional stat summary

---
 R/Design-methods.R                | 12 +++++++++---
 man/simulate-DADesign-method.Rd   |  4 +++-
 man/simulate-Design-method.Rd     |  4 +++-
 man/simulate-DualDesign-method.Rd |  4 +++-
 4 files changed, 18 insertions(+), 6 deletions(-)

diff --git a/R/Design-methods.R b/R/Design-methods.R
index 3c521700c..03cc9df72 100644
--- 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
index 254cc85d9..25f81651f 100644
--- a/man/simulate-DADesign-method.Rd
+++ b/man/simulate-DADesign-method.Rd
@@ -67,7 +67,9 @@ clusters of the computer? (not default)}
 \item{nCores}{how many cores should be used for parallel computing?
 Defaults to the number of cores on the machine (maximum 5)}
 
-\item{derive}{A list of functions that derive statistics from the target dose samples.}
+\item{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.}
 
 \item{\dots}{not used}
 }
diff --git a/man/simulate-Design-method.Rd b/man/simulate-Design-method.Rd
index d96e8a1f2..07c9c1a5a 100644
--- a/man/simulate-Design-method.Rd
+++ b/man/simulate-Design-method.Rd
@@ -52,7 +52,9 @@ clusters of the computer? (not default)}
 \item{nCores}{how many cores should be used for parallel computing?
 Defaults to the number of cores on the machine, maximum 5.}
 
-\item{derive}{A list of functions that derive statistics from the target dose samples.}
+\item{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.}
 
 \item{\dots}{not used}
 }
diff --git a/man/simulate-DualDesign-method.Rd b/man/simulate-DualDesign-method.Rd
index 20eb4776b..63d43e1a5 100644
--- a/man/simulate-DualDesign-method.Rd
+++ b/man/simulate-DualDesign-method.Rd
@@ -61,7 +61,9 @@ clusters of the computer? (not default)}
 \item{nCores}{how many cores should be used for parallel computing?
 Defaults to the number of cores on the machine, maximum 5.}
 
-\item{derive}{A list of functions that derive statistics from the target dose samples.}
+\item{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.}
 
 \item{\dots}{not used}
 }