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_register_tools(): Tools: Register tools from btw

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

Tools

Register all of these tools with an ellmer chat using btw_register_tools(chat). 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.

btw_tool_env_describe_data_frame(): Tool: Describe data frame

btw_tool_env_describe_environment(): Tool: Describe an environment

btw_tool_files_list_files(): Tool: List files

btw_tool_files_read_text_file(): Tool: Read a file

btw_tool_ide_read_current_editor(): Tool: Read current file

btw_tool_docs_package_help_topics() btw_tool_docs_help_page() btw_tool_docs_available_vignettes() btw_tool_docs_vignette(): Tool: Describe R package documentation

btw_tool_session_package_info(): Tool: Gather information about a package or currently loaded packages

btw_tool_session_platform_info(): Tool: Describe user's platform