h_check_fun_formals

<a href="https://lifecycle.r-lib.org/articles/stages.html#experimental"><img src="figures/lifecycle-experimental.svg?package=crmPack&version=2.0.0" alt="[Experimental]"></a>
This helper function checks whether a given function <code>fun</code> has required or
allowed arguments. The argument check is based only on the names of the
arguments. No any further logic is verified here.

Implements a wide range of dose escalation
designs. The focus is on model-based designs, ranging from classical and
modern continual reassessment methods (CRMs) based on dose-limiting toxicity
endpoints to dual-endpoint designs taking into account a biomarker/efficacy
outcome. Bayesian inference is performed via MCMC sampling in JAGS, and it is easy
to setup a new design with custom JAGS code. However, it is also possible to
implement 3+3 designs for comparison or models with non-Bayesian estimation.
The whole package is written in a modular form in the S4 class system, making it
very flexible for adaptation to new models, escalation or stopping rules.
Further details are presented in
Sabanes Bove et al. (2019) <doi:10.18637/jss.v089.i10>.

Daniel Sabanes Bove

crmPack

Object-Oriented Implementation of Dose Escalation Designs

Wai Yin Yeung

Burak Kuersad Guenhan

Giuseppe Palermo

Thomas Jaki

Jiawen Zhu

Ziwei Liao

Dimitris Kontos

Marlene Schulte-Goebel

Doug Kelkhoff

Oliver Boix

Robert Adams

Clara Beck

John Kirkpatrick

Wojciech Wójciak

Guanya Peng

Prerana Chandratre

F. Hoffmann-La Roche AG 

Merck Healthcare KGaA 

Bayer AG 

RPACT GmbH 

h_check_fun_formals function

<dl><dt>fun</dt>
<dd>(<code>function</code>) a function name whose argument names will be
checked.</dd>
<dt>mandatory</dt>
<dd>(<code>character</code> or <code>NULL</code>) the names of the arguments which
must be present in <code>fun</code>. If <code>mandatory</code> is specified as <code>NULL</code> (default)
this requirement is ignored.</dd>
<dt>allowed</dt>
<dd>(<code>character</code> or <code>NULL</code>) the names of the arguments which
are allowed in <code>fun</code>. Names that do not belong to <code>allowed</code> are simply not
allowed. The <code>allowed</code> parameter is independent from the <code>mandatory</code>, in a
sense that if <code>mandatory</code> is specified as a <code>character</code> vector, it does not
have to be repeated in <code>allowed</code>. If <code>allowed</code> is specified as <code>NULL</code>
(default), then it means that there must be no any arguments in <code>fun</code>
(except these ones which are specified in <code>mandatory</code>).</dd></dl>

Arguments

<a href='https://lifecycle.r-lib.org/articles/stages.html#experimental'><img src='figures/lifecycle-experimental.svg' alt='[Experimental]' /></a>
This helper function checks whether a given function <code>fun</code> has required or
allowed arguments. The argument check is based only on the names of the
arguments. No any further logic is verified here.

Checking Formals of a Function — h_check_fun_formals

<dl>

<dt>fun</dt>
<dd>(<code>function</code>) a function name whose argument names will be
checked.</dd>


<dt>mandatory</dt>
<dd>(<code>character</code> or <code>NULL</code>) the names of the arguments which
must be present in <code>fun</code>. If <code>mandatory</code> is specified as <code>NULL</code> (default)
this requirement is ignored.</dd>


<dt>allowed</dt>
<dd>(<code>character</code> or <code>NULL</code>) the names of the arguments which
are allowed in <code>fun</code>. Names that do not belong to <code>allowed</code> are simply not
allowed. The <code>allowed</code> parameter is independent from the <code>mandatory</code>, in a
sense that if <code>mandatory</code> is specified as a <code>character</code> vector, it does not
have to be repeated in <code>allowed</code>. If <code>allowed</code> is specified as <code>NULL</code>
(default), then it means that there must be no any arguments in <code>fun</code>
(except these ones which are specified in <code>mandatory</code>).</dd>

</dl>

Checking Formals of a Function

h_check_fun_formals: Checking Formals of a Function

Description

Usage

Arguments