Learn R Programming

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

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

858,973

Version

0.9.0

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Kevin Ushey

Last Published

January 9th, 2019

Functions in rstudioapi (0.9.0)

hasColorConsole

Check if Console Supports ANSI Color Escapes
navigateToFile

Navigate to File
removeTheme

Remove a custom theme from RStudio.
restartSession

Restart the R Session
terminalVisible

Get Visible Terminal
translateLocalUrl

Translate Local URL
convertTheme

Convert a tmTheme to an RStudio Theme
createProjectTemplate

Create a Project Template
getActiveProject

Path to Active RStudio Project
getThemeInfo

Retrieve Themes
jobSetProgress

Set Job Progress
jobSetState

Set Job State
build-tools

Build Tools
callFun

Call an RStudio API function
isAvailable

Check if RStudio is running.
askForPassword

Ask the user for a password interactively
addTheme

Add a Custom Editor Theme
jobAdd

Add a Job
jobAddOutput

Add Job Output
askForSecret

Show Prompt for Secret Dialog
document_range

Create a Range
applyTheme

Apply an Editor Theme to RStudio
dictionaries

Interact with RStudio's Dictionaries
document_position

Create a Document Position
getThemes

Get Theme List
file-dialogs

Select a File / Folder
jobRemove

Remove a Job
getVersion

Return the current version of the RStudio API
rstudio-documents

Interact with Documents open in RStudio
persistent-values

Persistent Keys and Values
jobRunScript

Run R Script As Job
rstudio-editors

Retrieve Information about an RStudio Editor
terminalBusy

Is Terminal Busy
projects

Open a Project in RStudio
savePlotAsImage

Save Active RStudio Plot as an Image
jobAddProgress

Add Job Progress
previewSql

Preview SQL statement
terminalClear

Clear Terminal Buffer
sendToConsole

Send Code to the R Console
terminalKill

Kill Terminal
primary_selection

Extract the Primary Selection
readPreference

Read Preference
terminalContext

Retrieve Information about RStudio Terminals
previewRd

Preview an Rd topic in the Help pane
terminalActivate

Activate Terminal
terminalCreate

Create a Terminal
terminalBuffer

Get Terminal Buffer
showQuestion

Show Question Dialog Box
showDialog

Show Dialog Box
sourceMarkers

Display Source Markers
terminalList

Get All Terminal Ids
showPrompt

Show Prompt Dialog Box
terminalExecute

Execute Command
terminalRunning

Is Terminal Running
updateDialog

Updates a Dialog Box
terminalSend

Send Text to a Terminal
versionInfo

RStudio Version Information
terminalExitCode

Terminal Exit Code
viewer

View local web content within RStudio
writePreference

Write Preference
hasFun

Exists/get for RStudio functions
jobSetStatus

Set Job Status