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

rstudioapi (version 0.14)

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.14

License

MIT + file LICENSE

Issues

130

Pull Requests

3

Stars

168

Forks

37

Maintainer

Kevin Ushey

Last Published

August 22nd, 2022

Functions in rstudioapi (0.14)

dictionaries

Interact with RStudio's Dictionaries
jobAdd

Add a Job
document_position

Create a Document Position
hasFun

Exists/get for RStudio functions
highlightUi

Highlight UI Elements within the RStudio IDE
getThemeInfo

Retrieve Themes
getVersion

Return the current version of the RStudio API
getThemes

Get Theme List
hasColorConsole

Check if console supports ANSI color escapes.
askForSecret

Prompt user for secret
getActiveProject

Retrieve path to active RStudio project
isAvailable

Check if RStudio is running
jobAddProgress

Add Background Job Progress
launcherGetJob

Retrieve Workbench Job Information
jobSetState

Set Background Job State
getRStudioPackageDependencies

Get RStudio Package Dependencies
isJob

Detect RStudio Jobs
jobRemove

Remove a Background Job
launcherResourceLimit

Define a Workbench Launcher Resource Limit
launcherGetInfo

Retrieve Workbench Launcher Information
callFun

Call an RStudio API function
file-dialogs

Select a file / folder
jobSetStatus

Set Background Job Status
launcherSubmitJob

Submit a Workbench Job
chunk-callbacks

Register and Unregister a Chunk Callback
launcherContainer

Define a Workbench Launcher Container
jobAddOutput

Add Background Job Output
readPreference

Read Preference
rstudio-editors

Retrieve Information about an RStudio Editor
filesPaneNavigate

Navigate to a Directory in the Files Pane
projects

Open a project in RStudio
savePlotAsImage

Save active RStudio plot image
jobRunScript

Run R Script As Background Job
previewRd

Preview an Rd topic in the Help pane
launcherControlJob

Interact with (Control) a Workbench Job
persistent-values

Persistent keys and values
terminalExitCode

Terminal Exit Code
restartSession

Restart the R Session
selections

Manipulate User Selections in the RStudio IDE
translateLocalUrl

Translate Local URL
launcherPlacementConstraint

Define a Workbench Launcher Placement Constraint
rstudio-documents

Interact with Documents open in RStudio
launcherNfsMount

Define a Workbench Launcher NFS Mount
sendToConsole

Send code to the R console
unregisterCommandCallback

Unregister Command Callback
launcherAvailable

Check if Workbench Launcher is Available
launcherConfig

Define a Workbench Launcher Configuration
terminalKill

Kill Terminal
readRStudioPreference

Read RStudio Preference
systemUsername

Get System Username
registerCommandCallback

Register Command Callback
previewSql

Preview SQL statement
launcherGetJobs

Retrieve Workbench Job Information
launcherHostMount

Define a Workbench Launcher Host Mount
jobSetProgress

Set Background Job Progress
terminalBuffer

Get Terminal Buffer
terminalActivate

Activate Terminal
terminalClear

Clear Terminal Buffer
writePreference

Write Preference
terminalContext

Retrieve Information about RStudio Terminals
versionInfo

RStudio version information
terminalBusy

Is Terminal Busy
viewer

View local web content within RStudio
writeRStudioPreference

Write RStudio Preference
primary_selection

Extract the Primary Selection
updateDialog

Updates a Dialog Box
showPrompt

Show Prompt Dialog Box
showDialog

Show Dialog Box
terminalCreate

Create a Terminal
terminalExecute

Execute Command
userIdentity

Get User Identity
navigateToFile

Navigate to file
terminalRunning

Is Terminal Running
removeTheme

Remove a custom theme from RStudio.
sourceMarkers

Display source markers
registerCommandStreamCallback

Register Command Stream Callback
terminalList

Get All Terminal Ids
showQuestion

Show Question Dialog Box
launcherSubmitR

Execute an R Script as a Workbench Job
terminalSend

Send Text to a Terminal
terminalVisible

Get Visible Terminal
convertTheme

Convert a tmTheme to an RStudio Theme
build-tools

Build Tools
applyTheme

Apply an Editor Theme to RStudio
bugReport

File an RStudio Bug Report
askForPassword

Ask the user for a password interactively
createProjectTemplate

Create a Project Template
addTheme

Add a Custom Editor Theme
document_range

Create a Range
executeCommand

Execute Command