get_simulate_function.lm {enrichwith}

Function to compute/extract a simulate function for response vectors from an object of class lm/enriched_lm

Description

Function to compute/extract a simulate function for response vectors from an object of class lm/enriched_lm

Usage

## S3 method for class 'lm'
get_simulate_function(object, ...)

Arguments

object

an object of class lm orenriched_lm

...

currently not used

Details

The computed/extracted simulate function has arguments

coefficients

the regression coefficients at which the response vectors are simulated. If missing then the maximum likelihood estimates are used

dispersion

the dispersion parameter at which the response vectors are simulated. If missing then the maximum likelihood estimate is used

nsim

number of response vectors to simulate. Defaults to 1

seed

an object specifying if and how the random number generator should be initialized ('seeded'). It can be either NULL or an integer that will be used in a call to set.seed before simulating the response vectors. If set, the value is saved as the seed attribute of the returned value. The default, NULL will not change the random generator state, and return .Random.seed as the seed attribute, see Value