fyi_docs

Get All Help Documentation for a Package

Description

Extracts all help documentation as markdown, suitable for LLM consumption.

Usage

1fyi_docs(package, topics = NULL, pattern = NULL, format = c("markdown", "text"))

Arguments

  • package: Character. Package name.
  • topics: Optional character vector of specific topics to include.
  • pattern: Optional regex to filter topics by name.
  • format: Output format: “markdown” (default, clean) or “text” (Rd2txt).

Value

Character string of markdown, invisibly. Also prints to console.

Examples

1fyi_docs("sttapi")
2fyi_docs("sttapi", topics = c("transcribe", "set_stt_base"))
3fyi_docs("torch", pattern = "^nn_")
4fyi_docs("sttapi", format = "text")