/
cor_ma.Rd
47 lines (44 loc) · 1.75 KB
/
cor_ma.Rd
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/autocor.R
\name{cor_ma}
\alias{cor_ma}
\title{(Deprecated) MA(q) correlation structure}
\usage{
cor_ma(formula = ~1, q = 1, cov = FALSE)
}
\arguments{
\item{formula}{A one sided formula of the form \code{~ t}, or \code{~ t | g},
specifying a time covariate \code{t} and, optionally, a grouping factor
\code{g}. A covariate for this correlation structure must be integer
valued. When a grouping factor is present in \code{formula}, the
correlation structure is assumed to apply only to observations within the
same grouping level; observations with different grouping levels are
assumed to be uncorrelated. Defaults to \code{~ 1}, which corresponds to
using the order of the observations in the data as a covariate, and no
groups.}
\item{q}{A non-negative integer specifying the moving average (MA)
order of the ARMA structure. Default is 1.}
\item{cov}{A flag indicating whether ARMA effects should be estimated by
means of residual covariance matrices. This is currently only possible for
stationary ARMA effects of order 1. If the model family does not have
natural residuals, latent residuals are added automatically. If
\code{FALSE} (the default) a regression formulation is used that is
considerably faster and allows for ARMA effects of order higher than 1 but
is only available for \code{gaussian} models and some of its
generalizations.}
}
\value{
An object of class \code{cor_arma} containing solely moving
average terms.
}
\description{
This function is deprecated. Please see \code{\link{ma}} for the new syntax.
This function is a constructor for the \code{cor_arma} class,
allowing for moving average terms only.
}
\examples{
cor_ma(~visit|patient, q = 2)
}
\seealso{
\code{\link{cor_arma}}
}