dot-checkMicrobialGrowthArgs: Check MicrobialGrowth arguments (regression function)

.checkMicrobialGrowthArgsR Documentation

Check MicrobialGrowth arguments (regression function)

Description

Check the arguments passed to the regression function. Tests are generic for all models. For example, the same length for x and y, the type of the different arguments, the values inserted in start, lower and upper, etc. are tested

Usage

.checkMicrobialGrowthArgs(
  x,
  y,
  clip,
  start,
  lower,
  upper,
  nls.args,
  callbackError
)

Arguments

x

index series or time series.

y

values or list of values to regress (should not be logged).

clip

a pair of values indicating in which interval to clip the data y. When clip is missing, default values are used.

start

a named list of starting estimates. When start is missing, default values are used.

lower

a named list of lower bounds. When lower is missing, default values are used.

upper

a named list of upper bounds. When upper is missing, default values are used.

nls.args

additional parameters to use when calling nls.

callbackError

function to call on error during regression.

Details

During the check, the clip value is also updated. If the lower bound of clip is -Inf (default value), then this value is replaced by the smallest value greater than zero found in y.

Value

the modified clip value and raises an error if something is wrong.


MicrobialGrowth documentation built on April 12, 2025, 1:34 a.m.