# Safely Access the RStudio API

## Documentation for package ‘rstudioapi’ version 0.7

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

as.document_position | Create a Document Position
as.document_range | Create a Range
askForPassword | Ask the user for a password interactively
callFun | Call an RStudio API function
createProjectTemplate | Create a Project Template
documentSave | Interact with Documents open in RStudio
documentSaveAll | Interact with Documents open in RStudio
document_position | Create a Document Position
document_range | Create a Range
file-dialogs | Select a File / Folder
findFun | Exists/get for RStudio functions
getActiveDocumentContext | Retrieve Information about an RStudio Editor
getActiveProject | Path to Active RStudio Project
getConsoleEditorContext | Retrieve Information about an RStudio Editor
getPersistentValue | Persistent Keys and Values
getSourceEditorContext | Retrieve Information about an RStudio Editor
getThemeInfo | Retrieve Themes
getVersion | Return the current version of the RStudio API
hasColorConsole | Check if Console Supports ANSI Color Escapes
hasFun | Exists/get for RStudio functions
initializeProject | Open a Project in RStudio
insertText | Interact with Documents open in RStudio
is.document_position | Create a Document Position
is.document_range | Create a Range
isAvailable | Check if RStudio is running.
modifyRange | Interact with Documents open in RStudio
navigateToFile | Navigate to File
openProject | Open a Project in RStudio
persistent-values | Persistent Keys and Values
previewRd | Preview an Rd topic in the Help pane
primary_selection | Extract the Primary Selection
projects | Open a Project in RStudio
readPreference | Read Preference
restartSession | Restart the R Session
rstudio-documents | Interact with Documents open in RStudio
rstudio-editors | Retrieve Information about an RStudio Editor
savePlotAsImage | Save Active RStudio Plot as an Image
selectDirectory | Select a File / Folder
selectFile | Select a File / Folder
sendToConsole | Send Code to the R Console
setCursorPosition | Interact with Documents open in RStudio
setDocumentContents | Interact with Documents open in RStudio
setPersistentValue | Persistent Keys and Values
setSelectionRanges | Interact with Documents open in RStudio
showDialog | Show Dialog Box
showPrompt | Show Prompt Dialog Box
showQuestion | Show Question Dialog Box
sourceMarkers | Display Source Markers
terminalActivate | Activate Terminal
terminalBuffer | Get Terminal Buffer
terminalBusy | Is Terminal Busy
terminalClear | Clear Terminal Buffer
terminalContext | Retrieve Information about RStudio Terminals
terminalCreate | Create a Terminal
terminalExecute | Execute Command
terminalExitCode | Terminal Exit Code
terminalKill | Kill Terminal
terminalList | Get All Terminal Ids
terminalRunning | Is Terminal Running
terminalSend | Send Text to a Terminal
terminalVisible | Get Visible Terminal
updateDialog | Updates a Dialog Box
verifyAvailable | Check if RStudio is running.
versionInfo | RStudio Version Information
viewer | View local web content within RStudio
writePreference | Write Preference