mc_offset: Create a model component object for an offset, i.e. fixed,...

View source: R/mc_offset.R

mc_offsetR Documentation

Create a model component object for an offset, i.e. fixed, non-parametrized term in the linear predictor

Description

This function is intended to be used on the right hand side of the formula argument to create_sampler or generate_data.

Usage

mc_offset(formula, value = NULL, name = "")

Arguments

formula

model formula.

value

alternative specification of an offset as a single scalar value that is the same for each data unit.

name

the name of the model component. This name is used in the output of the MCMC simulation function MCMCsim. By default the name will be 'mc_offset' with the number of the model term attached.

Value

An model component object with data and methods needed for dealing with an offset term in model estimation, and prior and posterior prediction. Intended for internal use by other package functions.


mcmcsae documentation built on April 12, 2025, 2:25 a.m.