Learn R Programming

rstudioapi (version 0.18.0)

Safely Access the RStudio API

Description

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

Copy Link

Version

Install

install.packages('rstudioapi')

Monthly Downloads

818,999

Version

0.18.0

License

MIT + file LICENSE

Issues

135

Pull Requests

2

Stars

173

Forks

36

Maintainer

Kevin Ushey

Last Published

January 16th, 2026

Functions in rstudioapi (0.18.0)

getOAuthIntegration

Get a Specific OAuth Integration
hasFun

Exists/get for RStudio functions
getThemes

Get Theme List
getOAuthIntegrations

Get OAuth Integrations
hasColorConsole

Check if console supports ANSI color escapes.
getOAuthCredentials

Retrieve OAuth Credentials for Integrations
getVersion

Determine the version of RStudio
getRStudioPackageDependencies

Get RStudio Package Dependencies
getMode

Report whether RStudio Desktop or RStudio Server is in use
getThemeInfo

Retrieve Themes
jobRunScript

Run R Script As Background Job
jobAddOutput

Add Background Job Output
highlightUi

Highlight UI Elements within the RStudio IDE
isAvailable

Check if RStudio is running
jobRemove

Remove a Background Job
jobGetState

Get Background Job State
jobAdd

Add a Job
isJob

Detect RStudio Jobs
jobAddProgress

Add Background Job Progress
jobList

List Background Jobs
launcherAvailable

Check if Workbench Launcher is Available
jobSetProgress

Set Background Job Progress
launcherConfig

Define a Workbench Launcher Configuration
launcherContainer

Define a Workbench Launcher Container
launcherGetJob

Retrieve Workbench Job Information
launcherControlJob

Interact with (Control) a Workbench Job
jobSetStatus

Set Background Job Status
jobSetState

Set Background Job State
launcherGetInfo

Retrieve Workbench Launcher Information
launcherGetJobs

Retrieve Workbench Job Information
launcherNfsMount

Define a Workbench Launcher NFS Mount
previewSql

Preview SQL statement
previewRd

Preview an Rd topic in the Help pane
launcherResourceLimit

Define a Workbench Launcher Resource Limit
launcherHostMount

Define a Workbench Launcher Host Mount
persistent-values

Persistent keys and values
launcherSubmitJob

Submit a Workbench Job
navigateToFile

Navigate to file
launcherPlacementConstraint

Define a Workbench Launcher Placement Constraint
launcherSubmitR

Execute an R Script as a Workbench Job
registerCommandCallback

Register Command Callback
readRStudioPreference

Read RStudio Preference
rstudio-editors

Retrieve Information about an RStudio Editor
projects

Open a project in RStudio
rstudio-documents

Interact with Documents open in RStudio
registerCommandStreamCallback

Register Command Stream Callback
primary_selection

Extract the Primary Selection
readPreference

Read Preference
restartSession

Restart the R Session
removeTheme

Remove a custom theme from RStudio.
savePlotAsImage

Save active RStudio plot image
selections

Manipulate User Selections in the RStudio IDE
showPrompt

Show Prompt Dialog Box
sendToConsole

Send code to the R console
terminalActivate

Activate Terminal
systemUsername

Get System Username
setGhostText

Set ghost text
showDialog

Show Dialog Box
showQuestion

Show Question Dialog Box
sourceMarkers

Display source markers
terminalBusy

Is Terminal Busy
terminalContext

Retrieve Information about RStudio Terminals
terminalClear

Clear Terminal Buffer
terminalBuffer

Get Terminal Buffer
terminalList

Get All Terminal Ids
terminalCreate

Create a Terminal
terminalExecute

Execute Command
terminalKill

Kill Terminal
terminalExitCode

Terminal Exit Code
viewer

View local web content within RStudio
updateDialog

Updates a Dialog Box
translateLocalUrl

Translate Local URL
terminalRunning

Is Terminal Running
terminalVisible

Get Visible Terminal
userIdentity

Get User Identity
unregisterCommandCallback

Unregister Command Callback
versionInfo

RStudio version information
terminalSend

Send Text to a Terminal
writeRStudioPreference

Write RStudio Preference
writePreference

Write Preference