Help

The Help tab is a built-in R documentation browser. Search for any function, package, or topic and read its full help page without leaving the app.

R Documentation Browser

Type a function or topic into the search bar. Search takes what you type literally, so operators such as [[ or + work too.

Viewing Help Pages

Each help page follows R’s standard documentation layout. This is the page for mean.

A typical help page includes these sections:

  • Title and package badge give the function’s name and package, as in mean {base}.
  • Description summarizes what the function does.
  • Usage shows the signature, with every argument and its default.
  • Arguments explains each parameter.
  • Details covers behavior, edge cases and related functions.
  • Examples holds runnable code. Tap Run to run it in the Console.

Pages also show Value (what the function returns), Format, Note, Author(s), Source and References where they exist. Tables, as in ?mtcars or ?Syntax, are drawn in aligned columns, and web links are tappable.

The … menu copies the topic name, the usage, the examples or the page’s raw text. Done closes the page.

Accessing Help from the Console

You can open help pages directly from the Console using R’s built-in help syntax:

  • ?mean or help(mean) opens the help page for mean().
  • ?stats::median or ?dplyr::filter opens that package’s page, loaded or not. If the package isn’t installed, R says “there is no package called” in the Console.
  • Topics with dots, such as ?read.csv, work. A topic with no help page prints an error in the Console.
  • ?dplyr shows the package index page listing all its functions.

In the iPad 4-Pane Workspace, help opens in the Help pane. On iPhone, and on iPad with Sidebar Navigation, it opens as a sheet over the Console. The Help tab keeps your page when you switch panes or layouts.

Use ?package_name to browse a package’s full function index. This is a quick way to discover what a package offers.