trail_record

internal

Tools for AI-assisted qualitative data coding using large language
models ('LLMs') via the 'ellmer' package, supporting providers including
'OpenAI', 'Anthropic', 'Google', 'Azure', and local models via 'Ollama'.
Provides a 'codebook'-based workflow for defining coding instructions and
applying them to texts, images, and other data. Includes built-in 'codebooks'
for common applications such as sentiment analysis and policy coding, and
functions for creating custom 'codebooks' for specific research questions.
Supports systematic replication across models and settings, computing
inter-coder reliability statistics including Krippendorff's alpha
(Krippendorff 2019, <doi:10.4135/9781071878781>) and Fleiss' kappa
(Fleiss 1971, <doi:10.1037/h0031619>), as well as gold-standard validation
metrics including accuracy, precision, recall, and F1 scores following
Sokolova and Lapalme (2009, <doi:10.1016/j.ipm.2009.03.002>). Provides audit
trail functionality for documenting coding workflows following Lincoln and
Guba's (1985, ISBN:0803924313) framework for establishing trustworthiness
in qualitative research.

Seraphine F. Maerz

quallmer

Qualitative Analysis with Large Language Models

Kenneth Benoit

trail_record function

<dl><dt>data</dt>
<dd>A data frame containing the text to be annotated.</dd>
<dt>text_col</dt>
<dd>Character scalar. Name of the text column.</dd>
<dt>task</dt>
<dd>A quallmer task object.</dd>
<dt>setting</dt>
<dd>A <code>trail_setting</code> object describing the LLM configuration.</dd>
<dt>id_col</dt>
<dd>Optional character scalar identifying units.</dd>
<dt>cache_dir</dt>
<dd>Optional directory in which to cache Trails. If <code>NULL</code>, caching disabled.
For examples and tests, use <code><a href="/link/tempdir()?package=quallmer&version=0.4.0" data-mini-rdoc="quallmer::tempdir()">tempdir()</a></code> to comply with CRAN policies.</dd>
<dt>overwrite</dt>
<dd>Whether to overwrite existing cache.</dd>
<dt>annotate_fun</dt>
<dd>Function used to perform the annotation.</dd></dl>

Arguments

Trail record: reproducible quallmer annotation (deprecated) — trail_record

<dl>

<dt>data</dt>
<dd>A data frame containing the text to be annotated.</dd>


<dt>text_col</dt>
<dd>Character scalar. Name of the text column.</dd>


<dt>task</dt>
<dd>A quallmer task object.</dd>


<dt>setting</dt>
<dd>A <code>trail_setting</code> object describing the LLM configuration.</dd>


<dt>id_col</dt>
<dd>Optional character scalar identifying units.</dd>


<dt>cache_dir</dt>
<dd>Optional directory in which to cache Trails. If <code>NULL</code>, caching disabled.
For examples and tests, use <code><a href='https://rdrr.io/r/base/tempfile.html'>tempdir()</a></code> to comply with CRAN policies.</dd>


<dt>overwrite</dt>
<dd>Whether to overwrite existing cache.</dd>


<dt>annotate_fun</dt>
<dd>Function used to perform the annotation.</dd>

</dl>

trail_record: Trail record: reproducible quallmer annotation (deprecated)

Description

Usage

Value

Arguments

Details