rstudioapi v0.13


Monthly downloads



Safely Access the RStudio API

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

Functions in rstudioapi

Name Description
chunk-callbacks Register and Unregister a Chunk Callback
convertTheme Convert a tmTheme to an RStudio Theme
build-tools Build Tools
addTheme Add a Custom Editor Theme
callFun Call an RStudio API function
createProjectTemplate Create a Project Template
askForPassword Ask the user for a password interactively
askForSecret Prompt user for secret
bugReport File an RStudio Bug Report
file-dialogs Select a file / folder
getActiveProject Retrieve path to active RStudio project
jobRemove Remove a Job
jobRunScript Run R Script As Job
filesPaneNavigate Navigate to a Directory in the Files Pane
launcher Retrieve Launcher Information
jobSetStatus Set Job Status
sendToConsole Send code to the R console
previewRd Preview an Rd topic in the Help pane
previewSql Preview SQL statement
showDialog Show Dialog Box
applyTheme Apply an Editor Theme to RStudio
getThemeInfo Retrieve Themes
dictionaries Interact with RStudio's Dictionaries
document_range Create a Range
getVersion Return the current version of the RStudio API
launcherConfig Define a Launcher Configuration
launcherContainer Define a Launcher Container
jobAdd Add a Job
getThemes Get Theme List
isAvailable Check if RStudio is running
jobAddProgress Add Job Progress
jobAddOutput Add Job Output
executeCommand Execute Command
terminalVisible Get Visible Terminal
primary_selection Extract the Primary Selection
getRStudioPackageDependencies Get RStudio Package Dependencies
launcherNfsMount Define a Launcher NFS Mount
document_position Create a Document Position
launcherHostMount Define a Launcher Host Mount
projects Open a project in RStudio
terminalBuffer Get Terminal Buffer
terminalActivate Activate Terminal
removeTheme Remove a custom theme from RStudio.
restartSession Restart the R Session
jobSetProgress Set Job Progress
hasColorConsole Check if console supports ANSI color escapes.
updateDialog Updates a Dialog Box
launcherControlJob Interact with (Control) a Job
translateLocalUrl Translate Local URL
jobSetState Set Job State
launcherGetJob Retrieve Job Information
sourceMarkers Display source markers
terminalExecute Execute Command
systemUsername Get System Username
versionInfo RStudio version information
viewer View local web content within RStudio
userIdentity Get User Identity
hasFun Exists/get for RStudio functions
launcherSubmitR Execute an R Script as a Launcher Job
readRStudioPreference Read RStudio Preference
readPreference Read Preference
launcherSubmitJob Submit a Launcher Job
showPrompt Show Prompt Dialog Box
terminalKill Kill Terminal
showQuestion Show Question Dialog Box
terminalList Get All Terminal Ids
terminalExitCode Terminal Exit Code
terminalClear Clear Terminal Buffer
savePlotAsImage Save active RStudio plot image
terminalBusy Is Terminal Busy
selections Manipulate User Selections in the RStudio IDE
persistent-values Persistent keys and values
navigateToFile Navigate to file
highlightUi Highlight UI Elements within the RStudio IDE
writePreference Write Preference
launcherResourceLimit Define a Launcher Resource Limit
launcherPlacementConstraint Define a Launcher Placement Constraint
rstudio-documents Interact with Documents open in RStudio
rstudio-editors Retrieve Information about an RStudio Editor
terminalContext Retrieve Information about RStudio Terminals
terminalCreate Create a Terminal
writeRStudioPreference Write RStudio Preference
terminalRunning Is Terminal Running
terminalSend Send Text to a Terminal
No Results!

Vignettes of rstudioapi

No Results!

Last month downloads


License MIT + file LICENSE
RoxygenNote 7.1.1
VignetteBuilder knitr
Encoding UTF-8
NeedsCompilation no
Packaged 2020-11-11 23:34:30 UTC; kevinushey
Repository CRAN
Date/Publication 2020-11-12 21:50:02 UTC

Include our badge in your README