From 1cde2add2618032d8bbff7b7e994cf200ddc02b1 Mon Sep 17 00:00:00 2001
From: Friedrich Pahlke <friedrich.pahlke@rpact.com>
Date: Thu, 12 Dec 2024 09:46:53 +0100
Subject: [PATCH] Missing man pages added

---
 man/param_typeOfShapeMeans.Rd    | 21 +++++++++++++++++++++
 man/param_typeOfShapeRates.Rd    | 21 +++++++++++++++++++++
 man/param_typeOfShapeSurvival.Rd | 21 +++++++++++++++++++++
 man/resetOptions.Rd              | 30 ++++++++++++++++++++++++++++++
 man/saveOptions.Rd               | 26 ++++++++++++++++++++++++++
 5 files changed, 119 insertions(+)
 create mode 100644 man/param_typeOfShapeMeans.Rd
 create mode 100644 man/param_typeOfShapeRates.Rd
 create mode 100644 man/param_typeOfShapeSurvival.Rd
 create mode 100644 man/resetOptions.Rd
 create mode 100644 man/saveOptions.Rd

diff --git a/man/param_typeOfShapeMeans.Rd b/man/param_typeOfShapeMeans.Rd
new file mode 100644
index 0000000..ebeb8a9
--- /dev/null
+++ b/man/param_typeOfShapeMeans.Rd
@@ -0,0 +1,21 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/parameter_descriptions.R
+\name{param_typeOfShapeMeans}
+\alias{param_typeOfShapeMeans}
+\title{Parameter Description: Type Of Shape}
+\arguments{
+\item{typeOfShape}{The shape of the dose-response relationship over the treatment groups.
+This can be either \code{"linear"}, \code{"sigmoidEmax"}, or \code{"userDefined"},
+default is \code{"linear"}.\cr
+For \code{"linear"}, \code{muMaxVector} specifies the range
+of effect sizes for the treatment group with highest response.
+If \code{"sigmoidEmax"} is selected, \code{gED50} and \code{slope} has to be entered
+to specify the ED50 and the slope of the sigmoid Emax model.
+For \code{"sigmoidEmax"}, \code{muMaxVector} specifies the range
+of effect sizes for the treatment group with response according to infinite dose.
+If \code{"userDefined"} is selected, \code{effectMatrix} has to be entered.}
+}
+\description{
+Parameter Description: Type Of Shape
+}
+\keyword{internal}
diff --git a/man/param_typeOfShapeRates.Rd b/man/param_typeOfShapeRates.Rd
new file mode 100644
index 0000000..9ad036e
--- /dev/null
+++ b/man/param_typeOfShapeRates.Rd
@@ -0,0 +1,21 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/parameter_descriptions.R
+\name{param_typeOfShapeRates}
+\alias{param_typeOfShapeRates}
+\title{Parameter Description: Type Of Shape}
+\arguments{
+\item{typeOfShape}{The shape of the dose-response relationship over the treatment groups.
+This can be either \code{"linear"}, \code{"sigmoidEmax"}, or \code{"userDefined"},
+default is \code{"linear"}.\cr
+For \code{"linear"}, \code{piMaxVector} specifies the range
+of effect sizes for the treatment group with highest response.
+If \code{"sigmoidEmax"} is selected, \code{gED50} and \code{slope} has to be entered
+to specify the ED50 and the slope of the sigmoid Emax model.
+For \code{"sigmoidEmax"}, \code{piMaxVector} specifies the range
+of effect sizes for the treatment group with response according to infinite dose.
+If \code{"userDefined"} is selected, \code{effectMatrix} has to be entered.}
+}
+\description{
+Parameter Description: Type Of Shape
+}
+\keyword{internal}
diff --git a/man/param_typeOfShapeSurvival.Rd b/man/param_typeOfShapeSurvival.Rd
new file mode 100644
index 0000000..5bd60be
--- /dev/null
+++ b/man/param_typeOfShapeSurvival.Rd
@@ -0,0 +1,21 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/parameter_descriptions.R
+\name{param_typeOfShapeSurvival}
+\alias{param_typeOfShapeSurvival}
+\title{Parameter Description: Type Of Shape}
+\arguments{
+\item{typeOfShape}{The shape of the dose-response relationship over the treatment groups.
+This can be either \code{"linear"}, \code{"sigmoidEmax"}, or \code{"userDefined"},
+default is \code{"linear"}.\cr
+For \code{"linear"}, \code{omegaMaxVector} specifies the range
+of effect sizes for the treatment group with highest response.
+If \code{"sigmoidEmax"} is selected, \code{gED50} and \code{slope} has to be entered
+to specify the ED50 and the slope of the sigmoid Emax model.
+For \code{"sigmoidEmax"}, \code{omegaMaxVector} specifies the range
+of effect sizes for the treatment group with response according to infinite dose.
+If \code{"userDefined"} is selected, \code{effectMatrix} has to be entered.}
+}
+\description{
+Parameter Description: Type Of Shape
+}
+\keyword{internal}
diff --git a/man/resetOptions.Rd b/man/resetOptions.Rd
new file mode 100644
index 0000000..9e5897e
--- /dev/null
+++ b/man/resetOptions.Rd
@@ -0,0 +1,30 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/f_core_utilities.R
+\name{resetOptions}
+\alias{resetOptions}
+\title{Reset Options}
+\usage{
+resetOptions(persist = TRUE)
+}
+\arguments{
+\item{persist}{A logical value indicating whether the reset options should be saved persistently.
+If \code{TRUE}, the options will be saved after resetting. Default is \code{TRUE}.}
+}
+\value{
+Returns \code{TRUE} if the options were successfully reset, \code{FALSE} otherwise.
+}
+\description{
+Resets the \code{rpact} options to their default values.
+}
+\details{
+This function resets all \code{rpact} options to their default values. If the \code{persist} parameter is set to \code{TRUE},
+the reset options will be saved to a configuration file.
+}
+\examples{
+\dontrun{
+resetOptions()
+resetOptions(persist = FALSE)
+}
+
+}
+\keyword{internal}
diff --git a/man/saveOptions.Rd b/man/saveOptions.Rd
new file mode 100644
index 0000000..2fe1dad
--- /dev/null
+++ b/man/saveOptions.Rd
@@ -0,0 +1,26 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/f_core_utilities.R
+\name{saveOptions}
+\alias{saveOptions}
+\title{Save Options}
+\usage{
+saveOptions()
+}
+\value{
+Returns \code{TRUE} if the options were successfully saved, \code{FALSE} otherwise.
+}
+\description{
+Saves the current \code{rpact} options to a configuration file.
+}
+\details{
+This function attempts to save the current \code{rpact} options to a configuration file
+located in the user's configuration directory. If the \code{rappdirs} package is not installed,
+the function will not perform any action. The options are saved in a YAML file.
+}
+\examples{
+\dontrun{
+saveOptions()
+}
+
+}
+\keyword{internal}