copula (version 1.1-4)

getTheta: Get the Parameter(s) of a Copula

Description

Get the parameter (vector) \(\theta\) (theta) of a copula, see setTheta for more background.

Usage

getTheta(copula, freeOnly = TRUE, attr = FALSE, named = attr)

Value

parameter vector of the copula, a numeric vector, possibly with names and other attributes (depending on the attr

and named arguments).

Arguments

copula

an R object of class "parCopula", e.g., "copula".

freeOnly

logical indicating that only non-fixed aka “free” parameters are to be returned (as vector).

attr

logical indicating if attributes (such as lower and uppder bounds for each parameters) are to be returned as well.

named

logical if the resulting parameter vector should have names.

Methods

signature(copula = "parCopula")

a default method, returning numeric(0).

signature(copula = "copula")

..

signature(copula = "acopula")

..

signature(copula = "khoudrajiCopula")

..

signature(copula = "mixCopula")

..

signature(copula = "rotCopula")

..

signature(copula = "Xcopula")

..

See Also

setTheta, its inverse.

Examples

showMethods("getTheta")
stopifnot(all.equal(
getTheta(setTheta(copClayton, 0.5)) # is 0.5
, 0.5))