From 2edd3962f4aa3aa3d4318fcbc5bf5789c6f57921 Mon Sep 17 00:00:00 2001 From: Friedrich Pahlke Date: Fri, 22 Mar 2024 17:38:21 +0100 Subject: [PATCH] Man pages improved --- R/f_simulation_base_count_data.R | 15 +++------------ R/parameter_descriptions.R | 10 ++++++++-- man/getSimulationCounts.Rd | 13 ++----------- man/param_plannedCalendarTime.Rd | 12 ++++++++++++ 4 files changed, 25 insertions(+), 25 deletions(-) create mode 100644 man/param_plannedCalendarTime.Rd diff --git a/R/f_simulation_base_count_data.R b/R/f_simulation_base_count_data.R index 9b63fe7e..8de73848 100644 --- a/R/f_simulation_base_count_data.R +++ b/R/f_simulation_base_count_data.R @@ -13,8 +13,8 @@ ## | ## | Contact us for information about our services: info@rpact.com ## | -## | File version: $Revision: 7742 $ -## | Last changed: $Date: 2024-03-22 13:46:29 +0100 (Fr, 22 Mrz 2024) $ +## | File version: $Revision: 7744 $ +## | Last changed: $Date: 2024-03-22 17:38:03 +0100 (Fr, 22 Mrz 2024) $ ## | Last changed by: $Author: pahlke $ ## | @@ -91,6 +91,7 @@ #' testing means rates for negative binomial distributed event numbers in the two treatment groups testing situation. #' #' @inheritParams param_design_with_default +#' @inheritParams param_plannedCalendarTime #' @inheritParams param_thetaH0 #' @inheritParams param_lambda_counts #' @inheritParams param_lambda1_counts @@ -108,27 +109,17 @@ #' @inheritParams param_minNumberOfSubjectsPerStage #' @inheritParams param_plannedMaxSubjectsPerStage #' @inheritParams param_conditionalPowerSimulation -#' @param lambda1H1 If specified, the assumed probability in the active treatment group if two treatment groups -#' are considered, or the assumed probability for a one treatment group design, for which the conditional -#' power was calculated. -#' @param lambda2H1 If specified, the assumed probability in the reference group if two treatment groups -#' are considered, for which the conditional power was calculated. #' @inheritParams param_maxNumberOfIterations #' @inheritParams param_calcSubjectsFunction #' @inheritParams param_seed #' @inheritParams param_three_dots #' @inheritParams param_showStatistics #' -#' #' @details #' At given design the function simulates the power, stopping probabilities, conditional power, and expected #' sample size at given number of subjects and parameter configuration. #' Additionally, an allocation ratio = n1/n2 and a null hypothesis value thetaH0 can be specified. #' -#' The definition of \code{lambda1H1} and/or \code{lambda2H1} makes only sense if \code{kMax} > 1 -#' and if \code{conditionalPower}, \code{minNumberOfSubjectsPerStage}, and -#' \code{plannedMaxSubjectsPerStage} (or \code{calcSubjectsFunction}) are defined. -#' #' @section Simulation Data: #' The summary statistics "Simulated data" contains the following parameters: median [range]; mean +/-sd\cr #' diff --git a/R/parameter_descriptions.R b/R/parameter_descriptions.R index da382f94..7f597996 100644 --- a/R/parameter_descriptions.R +++ b/R/parameter_descriptions.R @@ -13,8 +13,8 @@ ## | ## | Contact us for information about our services: info@rpact.com ## | -## | File version: $Revision: 7742 $ -## | Last changed: $Date: 2024-03-22 13:46:29 +0100 (Fr, 22 Mrz 2024) $ +## | File version: $Revision: 7744 $ +## | Last changed: $Date: 2024-03-22 17:38:03 +0100 (Fr, 22 Mrz 2024) $ ## | Last changed by: $Author: pahlke $ ## | @@ -917,3 +917,9 @@ NULL #' @name param_plannedMaxSubjects #' @keywords internal NULL + +#' Parameter Description: Planned Calendar Time +#' @param plannedCalendarTime TODO @Gernot please describe +#' @name param_plannedCalendarTime +#' @keywords internal +NULL diff --git a/man/getSimulationCounts.Rd b/man/getSimulationCounts.Rd index 8fb0efc6..b4cc17af 100644 --- a/man/getSimulationCounts.Rd +++ b/man/getSimulationCounts.Rd @@ -35,6 +35,8 @@ and \code{sided} can be directly entered as argument where necessary.} \item{...}{Ensures that all arguments (starting from the "...") are to be named and that a warning will be displayed if unknown arguments are passed.} +\item{plannedCalendarTime}{TODO @Gernot please describe} + \item{plannedMaxSubjects}{TODO @Gernot please describe} \item{lambda1}{A numeric value or vector that represents the assumed rate of a homogeneous Poisson process in @@ -99,13 +101,6 @@ recalculation. By default, sample size recalculation is performed with condition \item{showStatistics}{Logical. If \code{TRUE}, summary statistics of the simulated data are displayed for the \code{print} command, otherwise the output is suppressed, default is \code{FALSE}.} - -\item{lambda1H1}{If specified, the assumed probability in the active treatment group if two treatment groups -are considered, or the assumed probability for a one treatment group design, for which the conditional -power was calculated.} - -\item{lambda2H1}{If specified, the assumed probability in the reference group if two treatment groups -are considered, for which the conditional power was calculated.} } \value{ Returns a \code{\link{SimulationResults}} object. @@ -127,10 +122,6 @@ testing means rates for negative binomial distributed event numbers in the two t At given design the function simulates the power, stopping probabilities, conditional power, and expected sample size at given number of subjects and parameter configuration. Additionally, an allocation ratio = n1/n2 and a null hypothesis value thetaH0 can be specified. - -The definition of \code{lambda1H1} and/or \code{lambda2H1} makes only sense if \code{kMax} > 1 -and if \code{conditionalPower}, \code{minNumberOfSubjectsPerStage}, and -\code{plannedMaxSubjectsPerStage} (or \code{calcSubjectsFunction}) are defined. } \section{Simulation Data}{ diff --git a/man/param_plannedCalendarTime.Rd b/man/param_plannedCalendarTime.Rd new file mode 100644 index 00000000..8e10aa4b --- /dev/null +++ b/man/param_plannedCalendarTime.Rd @@ -0,0 +1,12 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/parameter_descriptions.R +\name{param_plannedCalendarTime} +\alias{param_plannedCalendarTime} +\title{Parameter Description: Planned Calendar Time} +\arguments{ +\item{plannedCalendarTime}{TODO @Gernot please describe} +} +\description{ +Parameter Description: Planned Calendar Time +} +\keyword{internal}