Metric Catalog (auto-generated)

This table lists all available metrics currently registered in TextAssociations.jl. It is generated automatically from the package’s internal list of metric types (METRIC_TYPES) via the available_metrics() function, ensuring the documentation always stays up-to-date.

using TextAssociations, Markdown

names = sort(string.(available_metrics()))
rows = String[]
push!(rows, "| Metric | Call example |")
push!(rows, "|:------ |:------------ |")
for n in names
    push!(rows, "| `$(n)` | `assoc_score($(n), data)` |")
end
Markdown.parse(join(rows, "\n"))
MetricCall example
AttrRiskassoc_score(AttrRisk, data)
BLLRassoc_score(BLLR, data)
BPMIassoc_score(BPMI, data)
BayesLLRassoc_score(BayesLLR, data)
ChiSquareassoc_score(ChiSquare, data)
ContCoefassoc_score(ContCoef, data)
CosineSimassoc_score(CosineSim, data)
CramersVassoc_score(CramersV, data)
CzekanowskiDiceCoefassoc_score(CzekanowskiDiceCoef, data)
DeltaPiLeftassoc_score(DeltaPiLeft, data)
DeltaPiRightassoc_score(DeltaPiRight, data)
Diceassoc_score(Dice, data)
FisherRightassoc_score(FisherRight, data)
GoodmanKruskalIdxassoc_score(GoodmanKruskalIdx, data)
GowerCoefassoc_score(GowerCoef, data)
GowerCoef2assoc_score(GowerCoef2, data)
HammanSimassoc_score(HammanSim, data)
HammanSim2assoc_score(HammanSim2, data)
JaccardIdxassoc_score(JaccardIdx, data)
KulczynskiSimassoc_score(KulczynskiSim, data)
LLRassoc_score(LLR, data)
LLR²assoc_score(LLR², data)
LexicalGravityassoc_score(LexicalGravity, data)
LogDiceassoc_score(LogDice, data)
LogOddsRatioassoc_score(LogOddsRatio, data)
LogRelRiskassoc_score(LogRelRisk, data)
MinSensassoc_score(MinSens, data)
MountfordCoefassoc_score(MountfordCoef, data)
MountfordCoef2assoc_score(MountfordCoef2, data)
OchiaiIdxassoc_score(OchiaiIdx, data)
OddsRatioassoc_score(OddsRatio, data)
OverlapCoefassoc_score(OverlapCoef, data)
PMIassoc_score(PMI, data)
PMI²assoc_score(PMI², data)
PMI³assoc_score(PMI³, data)
PPMIassoc_score(PPMI, data)
PhiCoefassoc_score(PhiCoef, data)
PiatetskyShapiroassoc_score(PiatetskyShapiro, data)
RelRiskassoc_score(RelRisk, data)
RiskDiffassoc_score(RiskDiff, data)
RogersTanimotoCoefassoc_score(RogersTanimotoCoef, data)
RogersTanimotoCoef2assoc_score(RogersTanimotoCoef2, data)
SokalMichenerCoefassoc_score(SokalMichenerCoef, data)
SokalSneathIdxassoc_score(SokalSneathIdx, data)
SorgenfreyIdxassoc_score(SorgenfreyIdx, data)
SorgenfreyIdx2assoc_score(SorgenfreyIdx2, data)
TanimotoCoefassoc_score(TanimotoCoef, data)
TschuprowTassoc_score(TschuprowT, data)
Tscoreassoc_score(Tscore, data)
YuleOmegaassoc_score(YuleOmega, data)
YuleQassoc_score(YuleQ, data)
Zscoreassoc_score(Zscore, data)

Notes

  • The list above is populated dynamically at build time.
  • You can inspect details of each metric type in the REPL using ?MetricName.
  • For implementation details, see Internals → Metric Implementations.