Learn R Programming
⚠️There's a newer version (0.17.0) of this package.Take me there.

rstudioapi (version 0.15.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

700,630

Version

0.15.0

License

MIT + file LICENSE

Issues

130

Pull Requests

3

Stars

167

Forks

37

Maintainer

Kevin Ushey

Last Published

July 7th, 2023

Functions in rstudioapi (0.15.0)

file-dialogs

Select a file / folder
launcherControlJob

Interact with (Control) a Workbench Job
getDelegatedAzureToken

OAuth2 Tokens for Delegated Azure Resources
launcherGetJobs

Retrieve Workbench Job Information
previewRd

Preview an Rd topic in the Help pane
jobSetProgress

Set Background Job Progress
previewSql

Preview SQL statement
launcherGetJob

Retrieve Workbench Job Information
jobSetState

Set Background Job State
getActiveProject

Retrieve path to active RStudio project
askForSecret

Prompt user for secret
filesPaneNavigate

Navigate to a Directory in the Files Pane
jobRemove

Remove a Background Job
jobRunScript

Run R Script As Background Job
highlightUi

Highlight UI Elements within the RStudio IDE
launcherResourceLimit

Define a Workbench Launcher Resource Limit
isAvailable

Check if RStudio is running
launcherPlacementConstraint

Define a Workbench Launcher Placement Constraint
rstudio-editors

Retrieve Information about an RStudio Editor
rstudio-documents

Interact with Documents open in RStudio
dictionaries

Interact with RStudio's Dictionaries
terminalBusy

Is Terminal Busy
writePreference

Write Preference
launcherConfig

Define a Workbench Launcher Configuration
getVersion

Return the current version of the RStudio API
document_position

Create a Document Position
jobSetStatus

Set Background Job Status
terminalClear

Clear Terminal Buffer
terminalExecute

Execute Command
launcherContainer

Define a Workbench Launcher Container
viewer

View local web content within RStudio
getThemes

Get Theme List
terminalExitCode

Terminal Exit Code
primary_selection

Extract the Primary Selection
launcherAvailable

Check if Workbench Launcher is Available
showPrompt

Show Prompt Dialog Box
launcherHostMount

Define a Workbench Launcher Host Mount
showQuestion

Show Question Dialog Box
projects

Open a project in RStudio
sendToConsole

Send code to the R console
navigateToFile

Navigate to file
readRStudioPreference

Read RStudio Preference
terminalActivate

Activate Terminal
persistent-values

Persistent keys and values
readPreference

Read Preference
showDialog

Show Dialog Box
terminalBuffer

Get Terminal Buffer
launcherNfsMount

Define a Workbench Launcher NFS Mount
removeTheme

Remove a custom theme from RStudio.
restartSession

Restart the R Session
terminalContext

Retrieve Information about RStudio Terminals
launcherGetInfo

Retrieve Workbench Launcher Information
savePlotAsImage

Save active RStudio plot image
updateDialog

Updates a Dialog Box
unregisterCommandCallback

Unregister Command Callback
launcherSubmitR

Execute an R Script as a Workbench Job
registerCommandCallback

Register Command Callback
launcherSubmitJob

Submit a Workbench Job
terminalList

Get All Terminal Ids
selections

Manipulate User Selections in the RStudio IDE
versionInfo

RStudio version information
terminalSend

Send Text to a Terminal
terminalKill

Kill Terminal
terminalRunning

Is Terminal Running
userIdentity

Get User Identity
terminalCreate

Create a Terminal
registerCommandStreamCallback

Register Command Stream Callback
writeRStudioPreference

Write RStudio Preference
systemUsername

Get System Username
terminalVisible

Get Visible Terminal
sourceMarkers

Display source markers
translateLocalUrl

Translate Local URL
applyTheme

Apply an Editor Theme to RStudio
addTheme

Add a Custom Editor Theme
convertTheme

Convert a tmTheme to an RStudio Theme
askForPassword

Ask the user for a password interactively
createProjectTemplate

Create a Project Template
document_range

Create a Range
chunk-callbacks

Register and Unregister a Chunk Callback
callFun

Call an RStudio API function
bugReport

File an RStudio Bug Report
build-tools

Build Tools
getThemeInfo

Retrieve Themes
executeCommand

Execute Command
getRStudioPackageDependencies

Get RStudio Package Dependencies
isJob

Detect RStudio Jobs
jobAdd

Add a Job
jobAddOutput

Add Background Job Output
jobAddProgress

Add Background Job Progress
hasColorConsole

Check if console supports ANSI color escapes.
hasFun

Exists/get for RStudio functions