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

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

License

MIT + file LICENSE

Issues

130

Pull Requests

3

Stars

168

Forks

37

Maintainer

Kevin Ushey

Last Published

March 24th, 2024

Functions in rstudioapi (0.16.0)

jobRemove

Remove a Background Job
jobRunScript

Run R Script As Background Job
jobAddOutput

Add Background Job Output
hasColorConsole

Check if console supports ANSI color escapes.
launcherControlJob

Interact with (Control) a Workbench Job
launcherGetInfo

Retrieve Workbench Launcher Information
launcherGetJob

Retrieve Workbench Job Information
launcherGetJobs

Retrieve Workbench Job Information
jobAddProgress

Add Background Job Progress
jobSetState

Set Background Job State
jobSetProgress

Set Background Job Progress
jobSetStatus

Set Background Job Status
launcherPlacementConstraint

Define a Workbench Launcher Placement Constraint
launcherResourceLimit

Define a Workbench Launcher Resource Limit
primary_selection

Extract the Primary Selection
previewRd

Preview an Rd topic in the Help pane
launcherAvailable

Check if Workbench Launcher is Available
previewSql

Preview SQL statement
projects

Open a project in RStudio
registerCommandStreamCallback

Register Command Stream Callback
bugReport

File an RStudio Bug Report
registerCommandCallback

Register Command Callback
savePlotAsImage

Save active RStudio plot image
hasFun

Exists/get for RStudio functions
rstudio-documents

Interact with Documents open in RStudio
jobGetState

Get Background Job State
selections

Manipulate User Selections in the RStudio IDE
jobList

List Background Jobs
launcherHostMount

Define a Workbench Launcher Host Mount
readPreference

Read Preference
launcherNfsMount

Define a Workbench Launcher NFS Mount
rstudio-editors

Retrieve Information about an RStudio Editor
readRStudioPreference

Read RStudio Preference
terminalRunning

Is Terminal Running
terminalExitCode

Terminal Exit Code
terminalCreate

Create a Terminal
terminalKill

Kill Terminal
terminalList

Get All Terminal Ids
terminalExecute

Execute Command
getActiveProject

Retrieve path to active RStudio project
getDelegatedAzureToken

OAuth2 Tokens for Delegated Azure Resources
build-tools

Build Tools
highlightUi

Highlight UI Elements within the RStudio IDE
sendToConsole

Send code to the R console
terminalContext

Retrieve Information about RStudio Terminals
terminalClear

Clear Terminal Buffer
isAvailable

Check if RStudio is running
persistent-values

Persistent keys and values
launcherSubmitR

Execute an R Script as a Workbench Job
navigateToFile

Navigate to file
launcherSubmitJob

Submit a Workbench Job
showDialog

Show Dialog Box
showPrompt

Show Prompt Dialog Box
getVersion

Return the current version of the RStudio API
callFun

Call an RStudio API function
launcherConfig

Define a Workbench Launcher Configuration
chunk-callbacks

Register and Unregister a Chunk Callback
launcherContainer

Define a Workbench Launcher Container
getThemes

Get Theme List
removeTheme

Remove a custom theme from RStudio.
restartSession

Restart the R Session
terminalBuffer

Get Terminal Buffer
terminalSend

Send Text to a Terminal
unregisterCommandCallback

Unregister Command Callback
translateLocalUrl

Translate Local URL
terminalBusy

Is Terminal Busy
showQuestion

Show Question Dialog Box
terminalVisible

Get Visible Terminal
versionInfo

RStudio version information
sourceMarkers

Display source markers
viewer

View local web content within RStudio
setGhostText

Set ghost text
updateDialog

Updates a Dialog Box
systemUsername

Get System Username
terminalActivate

Activate Terminal
writePreference

Write Preference
writeRStudioPreference

Write RStudio Preference
userIdentity

Get User Identity
convertTheme

Convert a tmTheme to an RStudio Theme
applyTheme

Apply an Editor Theme to RStudio
askForSecret

Prompt user for secret
createProjectTemplate

Create a Project Template
askForPassword

Ask the user for a password interactively
dictionaries

Interact with RStudio's Dictionaries
addTheme

Add a Custom Editor Theme
file-dialogs

Select a file / folder
getRStudioPackageDependencies

Get RStudio Package Dependencies
document_range

Create a Range
document_position

Create a Document Position
filesPaneNavigate

Navigate to a Directory in the Files Pane
getThemeInfo

Retrieve Themes
isJob

Detect RStudio Jobs
executeCommand

Execute Command
jobAdd

Add a Job