https://github.com/cran/nacopula
Raw File
Tip revision: e24ab1e1bade02a8136bd488815825e92fa6acd7 authored by Martin Maechler on 18 August 2010, 00:00:00 UTC
version 0.4-3
Tip revision: e24ab1e
setTheta.Rd
\name{setTheta}
\alias{setTheta}
\title{Specify the Parameter of an Archimedean Copula}
\description{
  Set or change the parameter \eqn{\vartheta}{theta} (\code{theta}) of
  an Archimedean copula, i.e. \code{"\linkS4class{acopula}"} classed
  \code{x}.  This is used for construction of copula \dQuote{models}
  with a specified parameter, as, e.g., in \code{\link{onacopula}()}.
}
\usage{
setTheta(x, value, na.ok = TRUE)
}
\arguments{
  \item{x}{acopula}
  \item{value}{parameter value, \code{\link{numeric}} or
    \code{\link{NA}} (when \code{na.ok} is true.)}
  \item{na.ok}{logical indicating if \code{\link{NA}} values are ok for
    \code{theta}.}
}
\value{
  an \code{"\linkS4class{acopula}"} as \code{x}, just with the slot
  \code{theta} set to \code{value}.
}
\author{Martin Maechler}
\examples{
myC <- setTheta(copClayton, 0.5)
myC
}
\keyword{manip}
back to top