Safely Access the RStudio API
![[R logo]](../../../doc/html/Rlogo.svg)
![[Up]](../../../doc/html/left.jpg)
![[Top]](../../../doc/html/up.jpg)
Documentation for package ‘rstudioapi’ version 0.16.0
Help Pages
A B C D E F G H I J L M N O P R S T U V W
-- A --
| addTheme | Add a Custom Editor Theme |
| applyTheme | Apply an Editor Theme to RStudio |
| as.document_position | Create a Document Position |
| as.document_range | Create a Range |
| askForPassword | Ask the user for a password interactively |
| askForSecret | Prompt user for secret |
-- B --
| bugReport | File an RStudio Bug Report |
| build-tools | Build Tools |
| buildToolsCheck | Build Tools |
| buildToolsExec | Build Tools |
| buildToolsInstall | Build Tools |
-- C --
| callFun | Call an RStudio API function |
| chunk-callbacks | Register and Unregister a Chunk Callback |
| convertTheme | Convert a tmTheme to an RStudio Theme |
| createProjectTemplate | Create a Project Template |
-- D --
| dictionaries | Interact with RStudio's Dictionaries |
| dictionariesPath | Interact with RStudio's Dictionaries |
| documentClose | Interact with Documents open in RStudio |
| documentId | Interact with Documents open in RStudio |
| documentNew | Interact with Documents open in RStudio |
| documentOpen | Interact with Documents open in RStudio |
| documentPath | Interact with Documents open in RStudio |
| 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 |
-- E --
| executeCommand | Execute Command |
-- F --
| file-dialogs | Select a file / folder |
| filesPaneNavigate | Navigate to a Directory in the Files Pane |
| findFun | Exists/get for RStudio functions |
-- G --
| getActiveDocumentContext | Retrieve Information about an RStudio Editor |
| getActiveProject | Retrieve path to active RStudio project |
| getConsoleEditorContext | Retrieve Information about an RStudio Editor |
| getDelegatedAzureToken | OAuth2 Tokens for Delegated Azure Resources |
| getPersistentValue | Persistent keys and values |
| getRStudioPackageDependencies | Get RStudio Package Dependencies |
| getSourceEditorContext | Retrieve Information about an RStudio Editor |
| getThemeInfo | Retrieve Themes |
| getThemes | Get Theme List |
| getVersion | Return the current version of the RStudio API |
-- H --
| hasColorConsole | Check if console supports ANSI color escapes. |
| hasFun | Exists/get for RStudio functions |
| highlightUi | Highlight UI Elements within the RStudio IDE |
-- I --
| 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 |
| isBackgroundJob | Detect RStudio Jobs |
| isJob | Detect RStudio Jobs |
| isWorkbenchJob | Detect RStudio Jobs |
-- J --
| jobAdd | Add a Job |
| jobAddOutput | Add Background Job Output |
| jobAddProgress | Add Background Job Progress |
| jobGetState | Get Background Job State |
| jobList | List Background Jobs |
| jobRemove | Remove a Background Job |
| jobRunScript | Run R Script As Background Job |
| jobSetProgress | Set Background Job Progress |
| jobSetState | Set Background Job State |
| jobSetStatus | Set Background Job Status |
-- L --
| launcherAvailable | Check if Workbench Launcher is Available |
| launcherConfig | Define a Workbench Launcher Configuration |
| launcherContainer | Define a Workbench Launcher Container |
| launcherControlJob | Interact with (Control) a Workbench Job |
| launcherGetInfo | Retrieve Workbench Launcher Information |
| launcherGetJob | Retrieve Workbench Job Information |
| launcherGetJobs | Retrieve Workbench Job Information |
| launcherHostMount | Define a Workbench Launcher Host Mount |
| launcherNfsMount | Define a Workbench Launcher NFS Mount |
| launcherPlacementConstraint | Define a Workbench Launcher Placement Constraint |
| launcherResourceLimit | Define a Workbench Launcher Resource Limit |
| launcherSubmitJob | Submit a Workbench Job |
| launcherSubmitR | Execute an R Script as a Workbench Job |
-- M --
| modifyRange | Interact with Documents open in RStudio |
-- N --
| navigateToFile | Navigate to file |
-- O --
| openProject | Open a project in RStudio |
-- P --
| persistent-values | Persistent keys and values |
| previewRd | Preview an Rd topic in the Help pane |
| previewSql | Preview SQL statement |
| primary_selection | Extract the Primary Selection |
| projects | Open a project in RStudio |
-- R --
| readPreference | Read Preference |
| readRStudioPreference | Read RStudio Preference |
| registerChunkCallback | Register and Unregister a Chunk Callback |
| registerCommandCallback | Register Command Callback |
| registerCommandStreamCallback | Register Command Stream Callback |
| removeTheme | Remove a custom theme from RStudio. |
| restartSession | Restart the R Session |
| rstudio-documents | Interact with Documents open in RStudio |
| rstudio-editors | Retrieve Information about an RStudio Editor |
-- S --
| savePlotAsImage | Save active RStudio plot image |
| selectDirectory | Select a file / folder |
| selectFile | Select a file / folder |
| selectionGet | Manipulate User Selections in the RStudio IDE |
| selections | Manipulate User Selections in the RStudio IDE |
| selectionSet | Manipulate User Selections in the RStudio IDE |
| sendToConsole | Send code to the R console |
| setCursorPosition | Interact with Documents open in RStudio |
| setDocumentContents | Interact with Documents open in RStudio |
| setGhostText | Set ghost text |
| 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 |
| systemUsername | Get System Username |
-- T --
| 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 |
| translateLocalUrl | Translate Local URL |
-- U --
| unregisterChunkCallback | Register and Unregister a Chunk Callback |
| unregisterCommandCallback | Unregister Command Callback |
| updateDialog | Updates a Dialog Box |
| userDictionariesPath | Interact with RStudio's Dictionaries |
| userIdentity | Get User Identity |
-- V --
| verifyAvailable | Check if RStudio is running |
| versionInfo | RStudio version information |
| viewer | View local web content within RStudio |
-- W --
| writePreference | Write Preference |
| writeRStudioPreference | Write RStudio Preference |