Skip to content

rstudioapi

0.19.0Package record

Safely Access the RStudio API

287packages dependsuggested by 220
9.9Mdownloads / year
–test coverage
13/13flavors OK

Overview

About

Access the RStudio API (if available) and provide informative error messages when it's not.

Changes in 0.19.0
  • getDelegatedAzureToken() gains an as argument. With as = "AzureToken", the token is returned as an R6 object compatible with the AzureToken class from the AzureAuth package, so it can be passed directly to packages like AzureGraph and Microsoft365R. (rstudio/rstudio#17619)
  • getDelegatedAzureToken() now returns the same token shape in all IDEs: the relative expires_in field is converted to an absolute expires_at timestamp, matching what RStudio sessions already returned.
  • getMode() no longer fails on very old versions of RStudio that lack the internal .rs.isDesktop() helper. In that case, it now falls back to versionInfo()$mode, which has been available since RStudio 0.97.124. (#326)
  • Added showEditSuggestion() for displaying edit suggestions in the RStudio editor. The function takes a document range and suggested replacement text, allowing RStudio to present a visual diff that users can accept or dismiss.

From NEWS.md in the release

Install

Health

CRAN checks
13OK
Slowest check: 2.5 min · r-release-macos-x86_64
Status changes
  • OK13 OK2026-08-04
  • NOTE12 OK, 1 NOTE2026-08-01
  • OK13 OK2026-06-09
  • ERROR12 OK, 1 ERROR2026-06-08
  • OK12 OK2026-04-27
Show 2 earlier changesHide 2 earlier changes
  • NOTE13 OK, 1 NOTE2026-03-30
  • OK14 OK2026-03-10
Advisories

none known

Documentation

In release 0.19.0
README· In the repository, left out of the releaseVignettesYes · 7 · dynamicNEWSYes · 100% structured · mentions 0.19.0Citation fileNoWebsiteYes · pkgdown
Help pages
101
Examples that run
14%4 run in a plain check · 25 never run
Exported functions with examples
29%
Documented parameters
100%
Return-value docs
33%
Help pages citing references
0%

Downloads

9.9M
CRAN downloads in the past year
Rank #81 · ~27.2K/day · ~827.3K/mo
Daily download trend is not available in this view yet.
745.6K30 days
2.3M90 days
9.9M1 year
Compare downloads with other packages →
Also on193.7K r2u1.8K autocran1.3M conda_forge19.8K c2d4u

Repository

175Stars
37Forks
134Open issues
1Open PRs
2Releases
485Commits
25Commit identities
485 commits · Last activity 2026-10-05 · Default branch at 0.19.0.9000, ahead of CRAN 0.19.0 (checked 2026-10-18)
Responsiveness
How these are sampled
PRs merged (all time)
85%
Median days to close, 50 most recently updated closed issues
12
Median days to close, 50 most recently updated closed PRs
1

PRs over time

2026-07-14 · 22026-10-06 · 1
PracticesBeta

9 development-tooling and community-health practices detected across 5 families in the upstream repository

Checks run against github.com/rstudio/rstudioapi on 2026-10-18.

Continuous integration (2)
GitHub ActionsR CMD check workflow

The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel

Docs source (4)
README.Rmdpkgdown

GitHub Pages site last deployed 2026-06-11 · The repository has a site deploy workflow

pkgdown site last built 2026-06-11

Coverage (1)
Coverage reporting (Codecov)
CRAN release process (1)
cran-comments.md
Show all practicesHide 1 practice
Lint, format, editor (1)
RStudio project
How this is detected·Detection ruleset v3 (2026-09-26)

Dependencies

Declared dependencies
9 external dependencies (excludes base and recommended)

Installing rstudioapi adds no packages beyond those that come with R.

Depends (0)
none
Imports (0)
none
LinkingTo (0)
none
Enhances (0)
none

People & History

People (5)
Author, Maintainer since 0.9.0 (2019) · added in 0.4.0
Author · added in 0.2
Author · added in 0.7
Author · added in 0.2
Copyright holder

Previously maintained by JJ Allaire (0.2 to 0.8) and Hadley Wickham (0.1).

Releases (20)

Pick two releases to compare their code metrics.

  • 0.19.0Latest
    record
    2026-06-11 · current release · diff ↗ ·
    added 1 export
    showEditSuggestion
  • R
    R 4.6.0 released · 2026-04-24
  • 0.18.0
    record
    2026-01-16 · diff ↗ ·
    added 5 exports
    findOAuthIntegration, getIdentityToken, getOAuthCredentials, getOAuthIntegration, getOAuthIntegrations
  • R
    R 4.5.0 released · 2025-04-11
  • 0.17.1
    record
    2024-10-23 · diff ↗
  • 0.17.0
    record
    2024-10-17 · diff ↗ ·
    added 1 export
    getMode
  • R
    R 4.4.0 released · 2024-04-24
  • 0.16.0
    record
    2024-03-24 · diff ↗ ·
    added 5 exports
    isBackgroundJob, isWorkbenchJob, jobGetState, jobList, setGhostText
  • 0.15.0
    record
    2023-07-07 · diff ↗ ·
    added 1 export
    getDelegatedAzureToken
  • R
    R 4.3.0 released · 2023-04-21
  • 0.14
    record
    2022-08-23 · diff ↗ ·
    added 5 exports
    documentOpen, isJob, registerCommandCallback, registerCommandStreamCallback, unregisterCommandCallback
  • R
    R 4.2.0 released · 2022-04-22
  • R
    R 4.1.0 released · 2021-05-18
  • 0.13
    record
    2020-11-12 · diff ↗
  • 0.12
    record
    2020-11-11 · diff ↗ ·
    added 7 exports
    documentId, documentPath, filesPaneNavigate, registerChunkCallback, selectionGet, selectionSet, unregisterChunkCallback
  • R
    R 4.0.0 released · 2020-04-24
Show 18 earlier eventsHide 18 earlier events
  • 0.11
    record
    2020-02-08 · diff ↗ ·
    added 7 exports
    bugReport, getRStudioPackageDependencies, highlightUi, readRStudioPreference, systemUsername, userIdentity, writeRStudioPreference
  • R
    R 3.6.0 released · 2019-04-26
  • 0.10
    record
    2019-03-19 · diff ↗ ·
    added 15 exports
    documentClose, executeCommand, launcherAvailable, launcherConfig, launcherContainer, launcherControlJob, launcherGetInfo, launcherGetJob, launcherGetJobs, launcherHostMount, launcherNfsMount, launcherPlacementConstraint, launcherResourceLimit, launcherSubmitJob, launcherSubmitR
  • 0.9.0
    record
    2019-01-09 · diff ↗ ·
    added 12 exports
    dictionariesPath, jobAdd, jobAddOutput, jobAddProgress, jobRemove, jobRunScript, jobSetProgress, jobSetState, jobSetStatus, removeTheme, translateLocalUrl, userDictionariesPath
  • 0.8
    record
    2018-10-02 · diff ↗ ·
    added 10 exports
    addTheme, applyTheme, askForSecret, buildToolsCheck, buildToolsExec, buildToolsInstall, convertTheme, documentNew, getThemes, previewSql
  • R
    R 3.5.0 released · 2018-04-23
  • 0.7
    record
    2017-09-07 · diff ↗ ·
    added 32 exports
    createProjectTemplate, documentSave, documentSaveAll, getPersistentValue, getThemeInfo, hasColorConsole, initializeProject, openProject, readPreference, restartSession, savePlotAsImage, selectDirectory, selectFile, setPersistentValue, showDialog, showPrompt, showQuestion, terminalActivate, terminalBuffer, terminalBusy, terminalClear, terminalContext, terminalCreate, terminalExecute, terminalExitCode, terminalKill, terminalList, terminalRunning, terminalSend, terminalVisible and 2 more
  • R
    R 3.4.0 released · 2017-04-21
  • 0.6
    record
    2016-06-27 · diff ↗ ·
    added 6 exports
    getConsoleEditorContext, getSourceEditorContext, primary_selection, sendToConsole, setCursorPosition, setSelectionRanges
  • R
    R 3.3.0 released · 2016-05-03
  • 0.5
    record
    2016-01-24 · diff ↗ ·
    added 2 exports
    askForPassword, getActiveProject
  • 0.4.0
    record
    2015-12-09 · diff ↗ ·
    added 11 exports
    as.document_position, as.document_range, document_position, document_range, getActiveDocumentContext, insertText, is.document_position, is.document_range, modifyRange, navigateToFile, setDocumentContents
  • R
    R 3.2.0 released · 2015-04-16
  • 0.3.1
    record
    2015-04-07 · diff ↗ ·
    added 1 export
    sourceMarkers
  • 0.2
    record
    2014-12-31 · diff ↗ ·
    added 3 exports
    previewRd, versionInfo, viewer
  • R
    R 3.1.0 released · 2014-04-10
  • 0.1
    record
    2014-03-27
  • R
    R 3.0.0 released · 2013-04-03

Package metadata

First published
2014-03-27
Total releases
20 / 12 yrs
License
MIT + file LICENSE OSI
Download size
128 KB

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("rstudioapi")
Ushey, K., Allaire, J., RStudio, , Ritchie, G., & Wickham, H. (2026). rstudioapi: Safely Access the RStudio API (Version 0.19.0) [Computer software]. https://doi.org/10.32614/CRAN.package.rstudioapi

This package has no citation file, so citation() returns this entry built from DESCRIPTION.

Cite the R Observatory

For a number measured here: a download total, a coverage figure, an archival date.

APA

Balamuta, J. J. (2026). R Observatory: Metrics for rstudioapi version 0.19.0 [Data set]. HJJB, LLC. Data release v2026-10-22. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-22, which the citation names so these numbers can be found later. More on citing and the projects behind them.

Report a problem with this page →

Privacy choices

These apply to this browser and are stored on this device only. Nothing about your choice is sent to us.

Read the privacy policy