Inspect a parsed hsquared model specification

Usage

model_spec(formula, data, family = stats::gaussian(), REML = TRUE, ...)

Arguments

formula

A model formula. The current implemented grammar is y ~ fixed + animal(1 | id, pedigree = ped), or y ~ fixed + animal(1 | id) when data is an hs_data() object with a pedigree component.

data

A data frame containing model variables, or an hs_data() object whose phenotypes component contains the model variables. When data is an hs_data object, formula arguments such as pedigree = pedigree can refer to named components in the bundle, and animal(1 | id) uses the bundle pedigree by default.

family

A response family. The current parser accepts only gaussian().

REML

Logical; whether the target Gaussian animal model would use REML.

...

Reserved for future arguments.

Value

An "hs_model_spec" object.

Details

model_spec() validates the narrow v0.1 animal-model grammar and returns the R-side model specification that would be used to build the Julia bridge payload. It is a preview and diagnostics helper: it does not fit a model.