printFormulae.asreml {asremlPlus}R Documentation

Prints the formulae from an asreml object.

Description

Prints the formulae nominated in the which argument from the call stored in an asreml object.

Usage

## S3 method for class 'asreml'
printFormulae(asreml.obj, which = c("fixed", "random", "residual"), 
              expanded = FALSE, envir = parent.frame(), ...)

Arguments

asreml.obj

An asreml object resulting from the fitting of a model using REML.

which

A character listing the formula(e) to be printed from the call stored in asreml.obj. It should be some combination of fixed, random, residual, sparse and all. If all is included then all formula(e) will be printed.

expanded

A logical indicating whether terms are to be expanded to the sum of a set of individual terms.

envir

The environment in which the formula(e) are to be evaluated. May also be NULL, a list, a data.frame, a pairlist or an integer as specified to sys.call.

...

Arguments passed on to getFormulae.asreml and ultimately to update.formula and terms.formula.

Value

Invisibly returns a character, each element of which contains one of the extracted formulae.

Author(s)

Chris Brien

See Also

printFormulae.asreml

Examples

## Not run: 
   data(Wheat.dat)
   current.asr <- asreml(yield ~ Rep + WithinColPairs + Variety, 
                         random = ~ Row + Column + units,
                         residual = ~ ar1(Row):ar1(Column), 
                         data=Wheat.dat)
    printFormulae(current.asr)

## End(Not run)

[Package asremlPlus version 4.2-32 Index]