get_r_documentation: Get R Documentation

View source: R/r_context_tools.R

get_r_documentationR Documentation

Get R Documentation

Description

Resolve an Rd topic and return a selected section.

Usage

get_r_documentation(
  name,
  package = NULL,
  section = c("summary", "usage", "arguments", "details", "value", "examples", "full"),
  session = NULL,
  envir = NULL,
  max_chars = 4000L
)

Arguments

name

Topic or function name.

package

Optional package/namespace name.

section

One of "summary", "usage", "arguments", "details", "value", "examples", or "full".

session

Optional ChatSession or SharedSession.

envir

Optional environment. Ignored when session is provided.

max_chars

Maximum characters to return.

Value

A character string with the requested documentation.


aisdk documentation built on May 29, 2026, 9:07 a.m.