svs (version 3.0.0)

pmi: Pointwise Mutual Information

Description

A function for computing the pointwise mutual information of every entry in a table.

Usage

pmi(x, normalize = FALSE, base = 2)
PMI(x, normalize = FALSE, base = 2)

Arguments

x

A table or a (sparse) matrix.

normalize

Logical indicating whether to normalize the pointwise mutual information.

base

Numeric specification of the base with respect to which logarithms are computed.

Value

An array with the pointwise mutual information of every entry.

See Also

MI.

Examples

# NOT RUN {
SndT_Fra <- read.table(system.file("extdata", "SndT_Fra.txt", package = "svs"),
   header = TRUE, sep = "\t", quote = "\"", encoding = "UTF-8",
   stringsAsFactors = FALSE)
tab.SndT_Fra <- table(SndT_Fra)
pmi(tab.SndT_Fra)
# }