Learn R Programming

expirest (version 0.1.6)

get_poi_list: List of points of intersection

Description

The function get_poi_list() prepares a list of points of intersection (POI) for multiple regression models using the find_poi() function.

Usage

get_poi_list(
  data,
  batch_vbl,
  model_list,
  sl,
  srch_range,
  mode = "minimal",
  alpha = 0.05,
  ivl = "confidence",
  ivl_type = "one.sided",
  ivl_side = "lower",
  ...
)

Value

A list of four elements named cics, dics, dids.pmse and dids is returned. Each of them contains a named vector of the POI values estimated for each batch and named accordingly.

Arguments

data

The data frame that was used for fitting the models of parameter model_list.

batch_vbl

A character string that specifies the column in data with the grouping information (i.e. a categorical variable) for the differentiation of the observations of the different batches.

model_list

A list of regression models of different type. Usually, it is a list of four elements named cics, dics, dids.pmse and dids, where the first three elements contain ‘lm’ objects of the “common intercept / common slope” (cics), “different intercept / common slope” (dics) and “different intercept / different slope” (dids.pmse) type. The fourth element with the label dids is usually a list of the ‘lm’ objects that is obtained from fitting a regression model to the data of each level of the categorical variable separately. The dids.pmse model differs from the dids model in that it is a model with the categorical variable as a fixed main effect and with an interaction term of the categorical variable with the time variable, i.e. a model where the mean square error is pooled across batches (thus the “pmse” suffix meaning “pooled mean square error”). The cics, dics and dids.pmse elements are NA if data of only a single batch is available.

sl

A numeric variable that specifies the “specification limit” (SL). Another kind of acceptance criterion may be regarded as SL.

srch_range

A vector of length 2 that specifies the endpoints of the (time) range within which the minimum distance is expected.

mode

A character string of either "minimal" or "all", that specifies if only the minimal distance of a factor regression model is returned or if the distances of all lines belonging to the different factor levels is returned. The default is "minimal".

alpha

A numeric value between 0 and 1 that specifies the significance level for the calculation of confidence or prediction intervals. The default is 0.05.

ivl

A character string of either "confidence" or "prediction" that specifies the type of interval of interest. The default is "confidence".

ivl_type

A character string that specifies if a “one sided” or a “two sided” interval should be calculated, i.e. either "one.sided" or "two.sided", respectively. The default is "one.sided".

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.

...

Additional named or unnamed arguments passed on to uniroot().

Details

The function get_poi_list() applies the find_poi() function (find the “point of intersection”) on all the models that are provided.

See Also

get_model_list, find_poi, get_distance, get_osle_poi_list, expirest_osle, expirest_wisle, uniroot.