Package index • btw

Core functions

btw(): Plain-text descriptions of R objects

btw_this(): Describe something for use by an LLM

btw_client() btw_app(): Create a btw-enhanced ellmer chat client

btw_tools(): Tools: Register tools from btw

btw_mcp_server() btw_mcp_session(): Start a Model Context Protocol server with btw tools

Project Context

use_btw_md() edit_btw_md(): Create or edit a btw.md context file

btw_task_create_btw_md(): Task: Initialize Project Context File

Describe R stuff

btw_this(): Describe something for use by an LLM

btw_this(<character>): Describe objects

btw_this(<environment>): Describe the contents of an environment

btw_this(<data.frame>) btw_this(<tbl>): Describe a data frame in plain text

Tasks and Agents

Tasks, or agents, are higher-level functions that combine system prompts and tools to perform more complex operations.

Tasks are typically designed for interactive use (e.g. to collaboratively create a project context file), but they can also be used programmatically.

btw_task_create_btw_md(): Task: Initialize Project Context File

btw_task_create_readme(): Task: Create a Polished README

Tools

Register all of these tools with an ellmer chat using chat$set_tools(btw_tools()). These tools generally all have counterparts available via btw() and btw_this() for interactive use. The long and awkward function names are for LLMs and to avoid name clashes with other tools.