Learn R Programming

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

855,686

Version

0.17.0

License

MIT + file LICENSE

Issues

131

Pull Requests

2

Stars

170

Forks

37

Maintainer

Kevin Ushey

Last Published

October 16th, 2024

Functions in rstudioapi (0.17.0)

highlightUi

Highlight UI Elements within the RStudio IDE
hasFun

Exists/get for RStudio functions
document_position

Create a Document Position
jobAdd

Add a Job
getVersion

Determine the version of RStudio
jobSetStatus

Set Background Job Status
hasColorConsole

Check if console supports ANSI color escapes.
launcherAvailable

Check if Workbench Launcher is Available
jobList

List Background Jobs
jobSetState

Set Background Job State
jobAddOutput

Add Background Job Output
launcherConfig

Define a Workbench Launcher Configuration
jobRemove

Remove a Background Job
getDelegatedAzureToken

OAuth2 Tokens for Delegated Azure Resources
launcherResourceLimit

Define a Workbench Launcher Resource Limit
launcherContainer

Define a Workbench Launcher Container
jobGetState

Get Background Job State
launcherGetJobs

Retrieve Workbench Job Information
previewSql

Preview SQL statement
isAvailable

Check if RStudio is running
isJob

Detect RStudio Jobs
launcherSubmitJob

Submit a Workbench Job
launcherHostMount

Define a Workbench Launcher Host Mount
launcherControlJob

Interact with (Control) a Workbench Job
jobAddProgress

Add Background Job Progress
readRStudioPreference

Read RStudio Preference
launcherNfsMount

Define a Workbench Launcher NFS Mount
setGhostText

Set ghost text
primary_selection

Extract the Primary Selection
launcherPlacementConstraint

Define a Workbench Launcher Placement Constraint
persistent-values

Persistent keys and values
rstudio-editors

Retrieve Information about an RStudio Editor
restartSession

Restart the R Session
previewRd

Preview an Rd topic in the Help pane
savePlotAsImage

Save active RStudio plot image
terminalBusy

Is Terminal Busy
terminalCreate

Create a Terminal
showDialog

Show Dialog Box
terminalContext

Retrieve Information about RStudio Terminals
sendToConsole

Send code to the R console
terminalActivate

Activate Terminal
selections

Manipulate User Selections in the RStudio IDE
registerCommandCallback

Register Command Callback
terminalVisible

Get Visible Terminal
translateLocalUrl

Translate Local URL
getThemeInfo

Retrieve Themes
file-dialogs

Select a file / folder
filesPaneNavigate

Navigate to a Directory in the Files Pane
terminalClear

Clear Terminal Buffer
projects

Open a project in RStudio
readPreference

Read Preference
registerCommandStreamCallback

Register Command Stream Callback
terminalBuffer

Get Terminal Buffer
showPrompt

Show Prompt Dialog Box
rstudio-documents

Interact with Documents open in RStudio
terminalRunning

Is Terminal Running
terminalSend

Send Text to a Terminal
getThemes

Get Theme List
removeTheme

Remove a custom theme from RStudio.
jobSetProgress

Set Background Job Progress
writeRStudioPreference

Write RStudio Preference
launcherGetInfo

Retrieve Workbench Launcher Information
launcherGetJob

Retrieve Workbench Job Information
userIdentity

Get User Identity
launcherSubmitR

Execute an R Script as a Workbench Job
jobRunScript

Run R Script As Background Job
navigateToFile

Navigate to file
terminalList

Get All Terminal Ids
terminalKill

Kill Terminal
terminalExecute

Execute Command
terminalExitCode

Terminal Exit Code
viewer

View local web content within RStudio
writePreference

Write Preference
versionInfo

RStudio version information
unregisterCommandCallback

Unregister Command Callback
updateDialog

Updates a Dialog Box
sourceMarkers

Display source markers
systemUsername

Get System Username
showQuestion

Show Question Dialog Box
chunk-callbacks

Register and Unregister a Chunk Callback
applyTheme

Apply an Editor Theme to RStudio
build-tools

Build Tools
addTheme

Add a Custom Editor Theme
askForSecret

Prompt user for secret
convertTheme

Convert a tmTheme to an RStudio Theme
bugReport

File an RStudio Bug Report
callFun

Call an RStudio API function
askForPassword

Ask the user for a password interactively
createProjectTemplate

Create a Project Template
dictionaries

Interact with RStudio's Dictionaries
getActiveProject

Retrieve path to active RStudio project
document_range

Create a Range
getMode

Report whether RStudio Desktop or RStudio Server is in use
getRStudioPackageDependencies

Get RStudio Package Dependencies
executeCommand

Execute Command