cyl_vonmises {cylcop}

Construction of 'cyl_vonmises' Objects

Description

Constructs a circular-linear von Mises copula according to Johnson and Wehrly (1978) 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

Johnson RA, Wehrly TE (1978). “Some Angular-Linear Distributions and Related Regression Models.” Journal of the American Statistical Association ISSN:, 73(363), 602–606. ISSN 00401706, doi:10.2307/1270921.

Hodel FH, Fieberg JR (2022). “Circular-Linear Copulae for Animal Movement Data.” Methods in Ecology and Evolution. doi:10.1111/2041-210X.13821.

Hodel FH, Fieberg JR (2021). “Cylcop: An R Package for Circular-Linear Copulae with Angular Symmetry.” bioRxiv. doi:10.1101/2021.07.14.452253, https://www.biorxiv.org/content/10.1101/2021.07.14.452253v3/.

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)
}