cyl_vonmises: Construction of "cyl_vonmises" Objects

In cylcop: Circular-Linear Copulas with Angular Symmetry for Movement Data

Construction of 'cyl_vonmises' Objects

Description

Constructs a circular-linear von Mises copula according to \insertCiteJohnson1978;textualcylcop of class 'cyl_vonmises'.

Usage

cyl_vonmises(mu = 0, kappa = 1, flip = FALSE)

Arguments

mu	numeric value giving the mean of the von Mises function used to construct the copula.
kappa	numeric value giving the concentration of the von Mises function used to construct the copula.
flip	logical value indicating whether the copula should be rotated 90 degrees to capture negative correlation.

Value

An R object of class 'cyl_vonmises'.

References

\insertRef

Johnson1978cylcop

\insertRef

Hodelapplcylcop

\insertRef

Hodelmethodcylcop

Examples

cop <- cyl_vonmises(mu=pi, kappa=10, flip = TRUE)
if(interactive()){
 plot_cop_surf(copula = cop, type = "pdf", plot_type = "ggplot", resolution = 20)
}

cop <- cyl_vonmises(mu=0, kappa=8, flip = FALSE)
if(interactive()){
 plot_cop_surf(copula = cop, type = "pdf", plot_type = "ggplot", resolution = 20)
}

cylcop documentation built on Oct. 30, 2022, 1:05 a.m.