Learn R Programming

expirest (version 0.1.6)

get_relevant_limits: Get relevant limits

Description

The function get_relevant_limits() expects a list returned by the function set_limits and returns a list of only the relevant limits, i.e. those that are relevant with respect to transformation.

Usage

get_relevant_limits(limits_list, xform = c("no", "no"), ivl_side = "lower")

Value

A list with the following elements is returned:

sl.orig

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

sl

A numeric value or a numeric vector of length 2 of adjusted specification limit(s).

rl.orig

A numeric value or a numeric vector that specifies the release limit(s) on the original scale. If NA was passed in, NA is returned.

rl

A numeric value or a numeric vector of adjusted release limit(s). If NA was passed in, NA is returned.

sl.bt

A numeric value or a numeric vector of length 2 of adjusted specification limit(s) before transformation. If no transformation has been performed it is NA.

rl.bt

A numeric value or a numeric vector of adjusted release limit(s) before transformation. If no transformation has been performed it is NA.

Arguments

limits_list

A list returned by the set_limits() function.

xform

A vector of two character strings that specifies 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).

ivl_side

A character string that specifies if the specification limit, given that the limit has only one side, is an “upper” or a “lower” bound, i.e. it is specified as either "upper" or "lower", respectively. The default is "lower". If the specification has two boundaries, then this parameter specifies the preferred side. If no side is preferred over the other, "both" can be used.

Details

The function get_relevant_limits() makes a subset of the list returned by the set_limits() function.

See Also

set_limits