-
Notifications
You must be signed in to change notification settings - Fork 27
/
Copy pathcoef.Rd
74 lines (63 loc) · 2.1 KB
/
coef.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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/coef.R, R/objfun.R
\docType{methods}
\name{coef}
\alias{coef}
\alias{coef<-}
\alias{coef<-,missing-method}
\alias{coef,listie-method}
\alias{coef,pomp-method}
\alias{coef<-,pomp-method}
\alias{coef,objfun-method}
\alias{coef<-,objfun-method}
\title{Extract, set, or alter coefficients}
\usage{
\S4method{coef}{listie}(object, ...)
\S4method{coef}{pomp}(object, pars, transform = FALSE, ...)
\S4method{coef}{pomp}(object, pars, transform = FALSE, ...) <- value
\S4method{coef}{objfun}(object, ...)
\S4method{coef}{objfun}(object, pars, transform = FALSE, ...) <- value
}
\arguments{
\item{object}{an object of class \sQuote{pomp}, or of a class extending \sQuote{pomp}}
\item{\dots}{ignored or passed to the more primitive function}
\item{pars}{optional character; names of parameters to be retrieved or set.}
\item{transform}{logical; perform parameter transformation?}
\item{value}{numeric vector or list; values to be assigned.
If \code{value = NULL}, the parameters are unset.}
}
\description{
Extract, set, or modify the estimated parameters from a fitted model.
}
\details{
\code{coef} allows one to extract the parameters from a fitted model.
\code{coef(object,transform=TRUE)} returns the parameters transformed onto
the estimation scale.
\code{coef(object) <- value} sets or alters the coefficients of a
\sQuote{pomp} object.
\code{coef(object,transform=TRUE) <- value} assumes that \code{value} is on
the estimation scale, and applies the \dQuote{from estimation scale}
parameter transformation from \code{object} before altering the
coefficients.
}
\seealso{
Other extraction methods:
\code{\link{cond_logLik}()},
\code{\link{covmat}()},
\code{\link{eff_sample_size}()},
\code{\link{filter_mean}()},
\code{\link{filter_traj}()},
\code{\link{forecast}()},
\code{\link{logLik}},
\code{\link{obs}()},
\code{\link{pred_mean}()},
\code{\link{pred_var}()},
\code{\link{saved_states}()},
\code{\link{spy}()},
\code{\link{states}()},
\code{\link{summary}()},
\code{\link{time}()},
\code{\link{timezero}()},
\code{\link{traces}()}
}
\concept{extraction methods}