npv: Negative Predictive Value

View source: R/metrics.R

npvR Documentation

Negative Predictive Value

Description

Computes negative predictive value from two PDAG caugi::caugi objects. It converts the caugi::caugi objects to adjacency matrices and computes negative predictive value as TN/(TN + FN), where TN are true negatives and FN are false negatives. If TN + FN = 0, 1 is returned.

Only supports caugi::caugi objects whose edges are restricted to ⁠-->⁠, ⁠<->⁠, ⁠---⁠, or absence of an edge.

Usage

npv(truth, est, type = c("adj", "dir"))

Arguments

truth

A caugi::caugi object representing the truth graph.

est

A caugi::caugi object representing the estimated graph.

type

Character string specifying the comparison type:

  • "adj": adjacency comparison.

  • "dir": orientation comparison conditional on shared adjacencies.

Value

A numeric in [0,1].

See Also

Other metrics: confusion(), evaluate(), f1_score(), false_omission_rate(), fdr(), g1_score(), precision(), recall(), reexports, specificity()

Examples

cg1 <- caugi::caugi(A %-->% B + C)
cg2 <- caugi::caugi(B %-->% A + C)
npv(cg1, cg2, type = "adj")
npv(cg1, cg2, type = "dir")


causalDisco documentation built on April 13, 2026, 5:06 p.m.