setCovOptions: The cache key of a covariance method's options

In nlmixr2est: Nonlinear Mixed Effects Models in Population PK/PD, Estimation Routines

The cache key of a covariance method's options

Description

setCov() records the result of this generic for every covariance it computes, and reuses a cached covariance only when the key it asks for is identical() to the recorded one. The default key is the control object itself, as a plain list.

Usage

setCovOptions(control, fit, ...)

## Default S3 method:
setCovOptions(control, fit, ...)

## S3 method for class 'rsControl'
setCovOptions(control, fit, ...)

Arguments

control	covariance control object (for example rsControl())
fit	nlmixr2 fit, or its environment when the key of a built-in method's defaults is taken
...	ignored

Details

A package whose covariance depends on more than its control – a covariance seeded from another covariance on the fit, say – adds a method for its control class that puts that state in the key, so a change in it recomputes the covariance instead of reinstalling a stale one. Options that do not change the result (parallel workers, say) can be left out.

Value

named list, compared with identical()

Author(s)

Matt Fidler

See Also

setCov()

Examples

setCovOptions(saControl(), NULL)

nlmixr2est documentation built on Sept. 20, 2026, 9:08 a.m.