calculate_metrics

Helper function that computes various association metrics for bigrams
based on their probability distributions. Supports PMI (Pointwise Mutual
Information), Dice's Coefficient, and G-score calculations.

internal

Support package for the textbook "An Introduction to
Quantitative Text Analysis for Linguists: Reproducible Research Using
R" (Francom, 2024) <doi:10.4324/9781003393764>. Includes functions to
acquire, clean, and analyze text data as well as functions to document
and share the results of text analysis. The package is designed to be
used in conjunction with the book, but can also be used as a standalone
package for text analysis.

Jerid Francom

qtkit

Quantitative Text Kit

calculate_metrics function

<dl><dt>bigram_probs</dt>
<dd>A data frame containing bigram probability data with
columns:<ul>
<li>p_xy Joint probability of bigram</li>
<li>p_x Marginal probability of first token</li>
<li>p_y Marginal probability of second token</li>
</ul></dd>
<dt>association</dt>
<dd>Character vector specifying which metrics to calculate</dd></dl>

Arguments

Calculate Association Metrics — calculate_metrics

<dl>

<dt>bigram_probs</dt>
<dd>A data frame containing bigram probability data with
columns:<ul>
<li>p_xy Joint probability of bigram</li>
<li>p_x Marginal probability of first token</li>
<li>p_y Marginal probability of second token</li>
</ul></dd>


<dt>association</dt>
<dd>Character vector specifying which metrics to calculate</dd>

</dl>

calculate_metrics: Calculate Association Metrics

Description

Usage

Value

Arguments