btw_this: Describe something for use by an LLM

View source: R/btw_this.R

btw_thisR Documentation

Describe something for use by an LLM

Description

A generic function used to describe an object for use by LLM.

Usage

btw_this(x, ...)

Arguments

x

The thing to describe.

...

Additional arguments passed down to underlying methods. Unused arguments are silently ignored.

Value

A character vector of lines describing the object.

See Also

Other btw formatting methods: btw_this.character(), btw_this.data.frame(), btw_this.environment()

Examples

btw_this(mtcars) # describe the mtcars dataset
btw_this(dplyr::mutate) # include function source


btw documentation built on Nov. 5, 2025, 7:45 p.m.