term {amba}R Documentation

term objects

Description

Creates term objects. The term class that defines term objects is intended as abstract. Until the package becomes more stable (e.g. version 1.0.0), and the process of defining term classes is documented, it would be unwise for users to try and use this directly.

Usage

term (d, e, s, x, E=NULL, I=NULL, validate=TRUE, clean=TRUE,
        nr=length (x), nc=1, nv, valid=NULL)
is.term (t)
## S3 method for class 'term':
fitted(t, ...)
## S3 method for class 'term':
residuals(t, y, ...)

Arguments

d A term design.
E An estimator.
I An inferencer.
e A term estimate.
s A symbol (e.g. a character) for x.
x Realisations of an explanatory variable.
validate Validates the term, refer to term.validate.
clean Whether or not the term is clean, that is, all x values are finite.
nr The number of realisations, usually the length of x. If x is a matrix or data.frame, then this is the number of rows.
nc The number of component (or nested) variables, usually 1. If x is a matrix or data.frame, then this is the number of columns.
nv The number of valid realisations. If clean, then nr = nv.
valid If unclean, then a logical vector, corresponding to valid realisations.
t A term object.
y Realisations of a response variable, or partial residuals.
...

[Package amba version 0.2.0 Index]