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

rstudioapi (version 0.10)

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

License

MIT + file LICENSE

Issues

134

Pull Requests

2

Stars

173

Forks

37

Maintainer

Kevin Ushey

Last Published

March 19th, 2019

Functions in rstudioapi (0.10)

jobAddOutput

Add Job Output
convertTheme

Convert a tmTheme to an RStudio Theme
getActiveProject

Path to Active RStudio Project
launcherResourceLimit

Define a Launcher Resource Limit
createProjectTemplate

Create a Project Template
file-dialogs

Select a File / Folder
document_position

Create a Document Position
jobRunScript

Run R Script As Job
updateDialog

Updates a Dialog Box
jobAdd

Add a Job
terminalExitCode

Terminal Exit Code
viewer

View local web content within RStudio
terminalExecute

Execute Command
terminalKill

Kill Terminal
jobSetState

Set Job State
launcherGetJob

Retrieve Job Information
dictionaries

Interact with RStudio's Dictionaries
build-tools

Build Tools
jobSetStatus

Set Job Status
savePlotAsImage

Save Active RStudio Plot as an Image
writePreference

Write Preference
previewSql

Preview SQL statement
launcherSubmitJob

Submit a Launcher Job
hasFun

Exists/get for RStudio functions
isAvailable

Check if RStudio is running.
launcherControlJob

Interact with (Control) a Job
persistent-values

Persistent Keys and Values
launcherContainer

Define a Launcher Container
translateLocalUrl

Translate Local URL
primary_selection

Extract the Primary Selection
terminalActivate

Activate Terminal
rstudio-documents

Interact with Documents open in RStudio
terminalBuffer

Get Terminal Buffer
rstudio-editors

Retrieve Information about an RStudio Editor
terminalList

Get All Terminal Ids
addTheme

Add a Custom Editor Theme
applyTheme

Apply an Editor Theme to RStudio
callFun

Call an RStudio API function
terminalRunning

Is Terminal Running
jobSetProgress

Set Job Progress
getThemeInfo

Retrieve Themes
getThemes

Get Theme List
sourceMarkers

Display Source Markers
getVersion

Return the current version of the RStudio API
hasColorConsole

Check if Console Supports ANSI Color Escapes
restartSession

Restart the R Session
launcherHostMount

Define a Launcher Host Mount
versionInfo

RStudio Version Information
showDialog

Show Dialog Box
jobAddProgress

Add Job Progress
previewRd

Preview an Rd topic in the Help pane
showPrompt

Show Prompt Dialog Box
jobRemove

Remove a Job
launcherNfsMount

Define a Launcher NFS Mount
document_range

Create a Range
askForSecret

Show Prompt for Secret Dialog
removeTheme

Remove a custom theme from RStudio.
projects

Open a Project in RStudio
askForPassword

Ask the user for a password interactively
readPreference

Read Preference
launcherPlacementConstraint

Define a Launcher Placement Constraint
terminalVisible

Get Visible Terminal
sendToConsole

Send Code to the R Console
showQuestion

Show Question Dialog Box
executeCommand

Execute Command
terminalSend

Send Text to a Terminal
terminalBusy

Is Terminal Busy
launcher

Retrieve Launcher Information
launcherConfig

Define a Launcher Configuration
launcherSubmitR

Execute an R Script as a Launcher Job
terminalClear

Clear Terminal Buffer
navigateToFile

Navigate to File
terminalContext

Retrieve Information about RStudio Terminals
terminalCreate

Create a Terminal