midr (version 0.5.0)

mid.extract: Extract Components from MID Models

Description

mid.extract() returns a component of a MID model.

Usage

mid.extract(object, component, ...)
mid.encoding.scheme(object, ...)
mid.frames(object, ...)
mid.terms(
  object,
  main.effect = TRUE,
  interaction = TRUE,
  require = NULL,
  remove = NULL,
  ...
)
# S3 method for mid
terms(x, ...)
# S3 method for mid.importance
terms(x, ...)
# S3 method for mid
formula(x, ...)
# S3 method for mid
model.frame(object, ...)

Value

mid.extract() returns the component extracted from the object, mid.encoding.scheme() returns a data frame containing the information about encoding schemes, mid.frames() returns a list of the encoding frames, mid.terms() returns a character vector of the term labels, and

Arguments

object

a "mid" object.

component

a literal character string or name. The name of the component to extract, such as "frames", "encoding.scheme" and "terms".

...

optional parameters to be passed to the function used to extract the component.

main.effect

logical. If FALSE, the main effect terms are excluded.

interaction

logical. If FALSE, the interaction terms are excluded.

require

a character vector of variable names. The terms that are not related to any of the specified names are excluded.

remove

a character vector of variable names. The terms that are related to at least one of the specified names are excluded.

x

a "mid" or "mid.importance" object.

Examples

data(trees, package = "datasets")
mid <- interpret(Volume ~ .^2, trees, k = 10)
mid.extract(mid, encoding.scheme)
mid.extract(mid, frames)
mid.extract(mid, Girth)
mid.extract(mid, intercept)