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

rstudioapi (version 0.8)

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

604,219

Version

0.8

License

MIT + file LICENSE

Issues

134

Pull Requests

2

Stars

172

Forks

37

Maintainer

JJ Allaire

Last Published

October 2nd, 2018

Functions in rstudioapi (0.8)

build-tools

Build Tools
askForSecret

Show Prompt for Secret Dialog
rstudio-documents

Interact with Documents open in RStudio
hasFun

Exists/get for RStudio functions
rstudio-editors

Retrieve Information about an RStudio Editor
isAvailable

Check if RStudio is running.
savePlotAsImage

Save Active RStudio Plot as an Image
showDialog

Show Dialog Box
showPrompt

Show Prompt Dialog Box
sendToConsole

Send Code to the R Console
showQuestion

Show Question Dialog Box
terminalVisible

Get Visible Terminal
updateDialog

Updates a Dialog Box
getVersion

Return the current version of the RStudio API
sourceMarkers

Display Source Markers
addTheme

Add a Custom Editor Theme
navigateToFile

Navigate to File
applyTheme

Apply an Editor Theme to RStudio
hasColorConsole

Check if Console Supports ANSI Color Escapes
convertTheme

Convert a tmTheme to an RStudio Theme
createProjectTemplate

Create a Project Template
persistent-values

Persistent Keys and Values
readPreference

Read Preference
primary_selection

Extract the Primary Selection
restartSession

Restart the R Session
projects

Open a Project in RStudio
terminalBusy

Is Terminal Busy
writePreference

Write Preference
viewer

View local web content within RStudio
getThemeInfo

Retrieve Themes
terminalClear

Clear Terminal Buffer
versionInfo

RStudio Version Information
document_position

Create a Document Position
terminalContext

Retrieve Information about RStudio Terminals
getThemes

Get Theme List
terminalRunning

Is Terminal Running
terminalSend

Send Text to a Terminal
terminalCreate

Create a Terminal
terminalExecute

Execute Command
document_range

Create a Range
terminalExitCode

Terminal Exit Code
file-dialogs

Select a File / Folder
getActiveProject

Path to Active RStudio Project
previewRd

Preview an Rd topic in the Help pane
terminalActivate

Activate Terminal
previewSql

Preview SQL statement
terminalBuffer

Get Terminal Buffer
terminalKill

Kill Terminal
terminalList

Get All Terminal Ids
askForPassword

Ask the user for a password interactively
callFun

Call an RStudio API function