fyi_help

Get Help Documentation for a Topic

Description

Extracts help documentation as markdown, suitable for LLM consumption.

Usage

1fyi_help(topic, package, format = c("markdown", "text"))

Arguments

  • topic: Character. The topic to get help for.
  • package: Character. Package name.
  • format: Output format: “markdown” (default, clean) or “text” (Rd2txt).

Value

Character string of help text, invisibly. Also prints to console.

Examples

1fyi_help("transcribe", "sttapi")
2fyi_help("transcribe", "sttapi", format = "text")