jsd: Jensen-Shannon Divergence

Description Usage Arguments Value See Also Examples

Description

Computes the Jensen-Shannon divergence between two probability distributions.

Usage

1
jsd(p, q, base = c("log", "log2", "log10"), margin = FALSE)

Arguments

p

numeric. probability distributions.

q

numeric. probability distributions.

base

character. log bases. "log", "log2", "log10". default is "log"

margin

logical. Choose whether to return individual values or totals. The default value is FALSE, which returns individual values.

Value

numeric. Jensen-Shannon divergence of probability distributions p and q.

See Also

kld.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# Sample data for probability distributions p.
event <- c(115, 76, 61, 39, 55, 10, 1)
no_event <- c(3, 3, 7, 10, 28, 44, 117)

p <- event / sum(event)
q <- no_event / sum(no_event)

jsd(p, q)
jsd(p, q, base = "log2")
jsd(p, q, margin = TRUE)

bit2r/kodlookr documentation built on Dec. 19, 2021, 9:49 a.m.