1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
|
% File nlme/man/Dim.corSpatial.Rd
% Part of the nlme package for R
% Distributed under GPL 2 or later: see nlme/LICENCE.note
\name{Dim.corSpatial}
\title{Dimensions of a corSpatial Object}
\usage{
\method{Dim}{corSpatial}(object, groups, \dots)
}
\alias{Dim.corSpatial}
\arguments{
\item{object}{an object inheriting from class \code{"\link{corSpatial}"},
representing a spatial correlation structure.}
\item{groups}{an optional factor defining the grouping of the
observations; observations within a group are correlated and
observations in different groups are uncorrelated.}
\item{\dots}{further arguments to be passed to or from methods.}
}
\description{
if \code{groups} is missing, it returns the \code{Dim} attribute of
\code{object}; otherwise, calculates the dimensions associated with
the grouping factor.
}
\value{
a list with components:
\item{N}{length of \code{groups}}
\item{M}{number of groups}
\item{spClass}{an integer representing the spatial correlation class;
0 = user defined class, 1 = \code{corSpher}, 2 = \code{corExp}, 3 =
\code{corGaus}, 4 = \code{corLin}}
\item{sumLenSq}{sum of the squares of the number of observations per
group}
\item{len}{an integer vector with the number of observations per
group}
\item{start}{an integer vector with the starting position for the
distance vectors in each group, beginning from zero}
}
\author{José Pinheiro and Douglas Bates \email{bates@stat.wisc.edu}}
\seealso{\code{\link{Dim}},
\code{\link{Dim.corStruct}}
}
\examples{
Dim(corGaus(), getGroups(Orthodont))
cs1ARMA <- corARMA(0.4, form = ~ 1 | Subject, q = 1)
cs1ARMA <- Initialize(cs1ARMA, data = Orthodont)
Dim(cs1ARMA)
}
\keyword{models}
|