Learn R Programming

expirest (version 0.1.5)

set_limits: Adjustment of limits

Description

The function set_limits() adjusts the limits according to the number of relevant decimal places and according to the transformation requirement.

Usage

set_limits(
  rl,
  rl_sf,
  sl,
  sl_sf,
  sf_option = "loose",
  xform = c("no", "no"),
  shift = c(0, 0),
  ivl_side = "lower"
)

Value

A list with the following elements is returned:

sf.option

A character string specifying the option concerning the significant figures.

xform

A vector of two character strings specifying the transformation of the response and the time variable.

shift

A vector of two values to be added to the values of the transformed \(x\) and/or \(y\) variables (specified via the xform parameter).

rl.orig

An optional element containing a numeric value or a numeric vector specifying the release limit(s) on the original scale.

rl.sf

An optional element containing a numeric value or a numeric vector specifying the significant figures of the release limit(s).

rl

An optional element containing a numeric value or a numeric vector of the adjusted (as specified by the sf.option parameter) release limit(s).

rl.trfmd

An optional element containing a numeric value or a numeric vector of the adjusted and transformed, if applicable (as specified by the the sf.option parameter and the second element of the xform parameter, respectively), release limit(s), otherwise the same as rl.

sl.orig

A numeric value or a numeric vector of length 2 specifying the specification limit(s) on the original scale.

sl.sf

A numeric value or a numeric vector of length 2 specifying the significant figures of the specification limit(s).

sl

A numeric value or a numeric vector of length 2 of the adjusted (as specified by the sf.option parameter) specification limit(s).

sl.trfmd

A numeric value or a numeric vector of length 2 of the adjusted and transformed, if applicable (as specified by the the sf.option parameter and the second element of the xform parameter, respectively) specification limit(s), otherwise the same as sl.

Arguments

sl

A numeric value or a numeric vector of length 2 specifying the specification limit or limits. If a vector is provided it must be of the form c(lower limit, upper limit).

sl_sf

A positive integer or a vector of positive integers specifying the number of “significant figures” (sf) of sl. It must have the same length as sl.

sf_option

A character string specifying if the limits (rl or sl) should be regarded as “tight” or “loose”, i.e. either "tight" or "loose", respectively. The option "tight" means that the limits are rounded to the specified number of significant figures specified by the parameters rl_sf and sl_sf. In case of the option "loose" the limits are rounded to the specified number of significant figures (\(n\)), followed by the subtraction of \(1\) from the \(n^{th}\) digit and addition of \(5\) to the \((n + 1)^{th}\) digit if ivl_side is "lower", or followed by the addition of \(4\) to the \((n + 1)^{th}\) digit if ivl_side is "upper".

xform

A vector of two character strings specifying the transformation of the response and the time variable. The default is “no” transformation, i.e. c("no", "no"), where the first element specifies the transformation of the \(x\) variable and the second element the transformation of the \(y\) variable. Valid alternatives for \(x\) and/or \(y\) variable transformation are "log" (natural logarithm), "sqrt" (square root) and "sq" (square).

shift

A vector of two values which will be added to the variables \(x\) and/or \(y\) before they are transformed as specified by the xform parameter, where the first element will be added to the \(x\) variable and the second element to the \(y\) variable. The purpose is to prevent an undefined state which could arise when variables with values of \(\leq 0\) are log or square root transformed. The default is c(0, 0).

ivl_side

A character string specifying if the “upper” or the “lower” limit is the relevant limit, i.e. either "upper" or "lower", respectively. The default is "lower".

Details

The function set_limits() adjusts the limits according to rl_sf and sl_sf and, if necessary, transforms the limits (rl and sl) as specified by the parameters xform and shift.