btw_tool_pkg_document

Generate package documentation using <code><a href="https://devtools.r-lib.org/reference/document.html">devtools::document()</a></code>. This runs
roxygen2 on the package to create/update man pages and <code>NAMESPACE</code>.

A complete toolkit for connecting 'R' environments with Large
Language Models (LLMs). Provides utilities for describing 'R' objects,
package documentation, and workspace state in plain text formats
optimized for LLM consumption. Supports multiple workflows:
interactive copy-paste to external chat interfaces, programmatic tool
registration with 'ellmer' chat clients, batteries-included chat
applications via 'shinychat', and exposure to external coding agents
through the Model Context Protocol. Project configuration files enable
stable, repeatable conversations with project-specific context and
preferred LLM settings.

Garrick Aden-Buie

A Toolkit for Connecting R and Large Language Models

btw_tool_pkg_document function

<dl><dt>pkg</dt>
<dd>Path to package directory. Defaults to <code>"."</code>. Must be within
current working directory.</dd>
<dt>_intent</dt>
<dd>An optional string describing the intent of the tool use.
When the tool is used by an LLM, the model will use this argument to
explain why it called the tool.</dd></dl>

Arguments

Generate package documentation using <code><a href='https://devtools.r-lib.org/reference/document.html'>devtools::document()</a></code>. This runs
roxygen2 on the package to create/update man pages and <code>NAMESPACE</code>.

Tool: Generate package documentation — btw_tool_pkg_document

<dl>

<dt>pkg</dt>
<dd>Path to package directory. Defaults to <code>"."</code>. Must be within
current working directory.</dd>


<dt>_intent</dt>
<dd>An optional string describing the intent of the tool use.
When the tool is used by an LLM, the model will use this argument to
explain why it called the tool.</dd>

</dl>

btw_tool_pkg_document: Tool: Generate package documentation

Description

Usage

Value

Arguments

See Also