bayestestR: overlap – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

overlap

Overlap Coefficient

Description

A method to calculate the overlap coefficient between two empirical distributions (that can be used as a measure of similarity between two samples).

Usage

overlap(
  x,
  y,
  method_density = "kernel",
  method_auc = "trapezoid",
  precision = 2^10,
  extend = TRUE,
  extend_scale = 0.1,
  ...
)

Arguments

`x`	Vector of x values.
`y`	Vector of x values.
`method_density`	Density estimation method. See `estimate_density`.
`method_auc`	Area Under the Curve (AUC) estimation method. See `area_under_curve`.
`precision`	Number of points of density data. See the `n` parameter in `density`.
`extend`	Extend the range of the x axis by a factor of `extend_scale`.
`extend_scale`	Ratio of range by which to extend the x axis. A value of `0.1` means that the x axis will be extended by `1/10` of the range of the data.
`...`	Currently not used.

Examples

library(bayestestR)

x <- distribution_normal(1000, 2, 0.5)
y <- distribution_normal(1000, 0, 1)

overlap(x, y)
plot(overlap(x, y))

bayestestR

Understand and Describe Bayesian Models and Posterior Distributions

v0.10.0

GPL-3

Authors

Dominique Makowski [aut, cre] (<https://orcid.org/0000-0001-5375-9967>, @Dom_Makowski), Daniel Lüdecke [aut] (<https://orcid.org/0000-0002-8895-3206>, @strengejacke), Mattan S. Ben-Shachar [aut] (<https://orcid.org/0000-0002-4287-4801>, @mattansb), Indrajeet Patil [aut] (<https://orcid.org/0000-0003-1995-6531>, @patilindrajeets), Michael D. Wilson [aut] (<https://orcid.org/0000-0003-4143-7308>), Paul-Christian Bürkner [rev], Tristan Mahr [rev] (<https://orcid.org/0000-0002-8890-5116>), Henrik Singmann [ctb] (<https://orcid.org/0000-0002-4842-3657>), Quentin F. Gronau [ctb] (<https://orcid.org/0000-0001-5510-6943>), Sam Crawley [ctb] (<https://orcid.org/0000-0002-7847-0411>)

Initial release