Package: rstudioapi 0.19.0.9000

Kevin Ushey

rstudioapi: Safely Access the RStudio API

Access the RStudio API (if available) and provide informative error messages when it's not.

Authors:Kevin Ushey [aut, cre], JJ Allaire [aut], Hadley Wickham [aut], Gary Ritchie [aut], RStudio [cph]

rstudioapi_0.19.0.9000.tar.gz
rstudioapi_0.19.0.9000.zip(r-4.7)rstudioapi_0.19.0.9000.zip(r-4.6)rstudioapi_0.19.0.9000.zip(r-4.5)
rstudioapi_0.19.0.9000.tgz(r-4.6-any)rstudioapi_0.19.0.9000.tgz(r-4.5-any)
rstudioapi_0.19.0.9000.tar.gz(r-4.7-any)rstudioapi_0.19.0.9000.tar.gz(r-4.6-any)
rstudioapi_0.19.0.9000.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
rstudioapi/json (API)

# Install 'rstudioapi' in R:

install.packages('rstudioapi', repos = c('https://rstudio.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/rstudio/rstudioapi/issues

Pkgdown/docs site:https://rstudio.github.io

On CRAN:

19.13 score 175 stars 2.3k packages 5.4k scripts 911k downloads 5 mentions 130 exports 0 dependencies

Last updated from:8856985a77. Checks:9 OK. Indexed: yes.

Target	Result	Time
linux-devel-x86_64	OK	128
source / vignettes	OK	159
linux-release-x86_64	OK	118
macos-release-arm64	OK	73
macos-oldrel-arm64	OK	72
windows-devel	OK	63
windows-release	OK	81
windows-oldrel	OK	71
wasm-release	OK	111

Exports:addTheme applyTheme as.document_position as.document_range askForPassword askForSecret bugReport buildToolsCheck buildToolsExec buildToolsInstall callFun convertTheme createProjectTemplate dictionariesPath document_position document_range documentClose documentId documentNew documentOpen documentPath documentSave documentSaveAll executeCommand filesPaneNavigate findFun findOAuthIntegration getActiveDocumentContext getActiveProject getConsoleEditorContext getDelegatedAzureToken getIdentityToken getMode getOAuthCredentials getOAuthIntegration getOAuthIntegrations getPersistentValue getRStudioPackageDependencies getSourceEditorContext getThemeInfo getThemes getVersion hasColorConsole hasFun highlightUi initializeProject insertText is.document_position is.document_range isAvailable isBackgroundJob isJob isWorkbenchJob jobAdd jobAddOutput jobAddProgress jobGetState jobList jobRemove jobRunScript jobSetProgress jobSetState jobSetStatus launcherAvailable launcherConfig launcherContainer launcherControlJob launcherGetInfo launcherGetJob launcherGetJobs launcherHostMount launcherNfsMount launcherPlacementConstraint launcherResourceLimit launcherSubmitJob launcherSubmitR modifyRange navigateToFile openProject previewRd previewSql primary_selection readPreference readRStudioPreference registerChunkCallback registerCommandCallback registerCommandStreamCallback removeTheme restartSession savePlotAsImage selectDirectory selectFile selectionGet selectionSet sendToConsole setCursorPosition setDocumentContents setGhostText setPersistentValue setSelectionRanges showDialog showEditSuggestion showPrompt showQuestion sourceMarkers systemUsername terminalActivate terminalBuffer terminalBusy terminalClear terminalContext terminalCreate terminalExecute terminalExitCode terminalKill terminalList terminalRunning terminalSend terminalVisible translateLocalUrl unregisterChunkCallback unregisterCommandCallback updateDialog userDictionariesPath userIdentity verifyAvailable versionInfo viewer writePreference writeRStudioPreference

Dependencies:

Interact with the R Session

Detecting RStudio | Session Interaction | Running at Startup

Rendered fromr-session.Rmdusingknitr::rmarkdown

Last update: 2025-10-03
Started: 2017-07-20

Interacting with Terminals

Rendered fromterminal.Rmdusingknitr::rmarkdown

Last update: 2023-07-07
Started: 2017-08-28

Interfacing with RStudio in Visual Mode

Rendered fromvisual-mode.Rmdusingknitr::rmarkdown

Last update: 2020-09-21
Started: 2020-09-18

Document Manipulation

Rendered fromdocument-manipulation.Rmdusingknitr::rmarkdown

Last update: 2017-08-24
Started: 2017-07-20

File Dialogs

Rendered fromdialogs.Rmdusingknitr::rmarkdown

Last update: 2017-08-24
Started: 2017-07-20

Introduction to rstudioapi

Rendered fromintroduction.Rmdusingknitr::rmarkdown

Last update: 2017-08-24
Started: 2017-07-20

Interacting with RStudio Projects

Rendered fromprojects.Rmdusingknitr::rmarkdown

Last update: 2017-07-20
Started: 2017-07-20

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
Add a Custom Editor Theme	addTheme
Apply an Editor Theme to RStudio	applyTheme
Ask the user for a password interactively	askForPassword
Prompt user for secret	askForSecret
File an RStudio Bug Report	bugReport
Build Tools	build-tools buildToolsCheck buildToolsExec buildToolsInstall
Call an RStudio API function	callFun
Register and Unregister a Chunk Callback	chunk-callbacks registerChunkCallback unregisterChunkCallback
Convert a tmTheme to an RStudio Theme	convertTheme
Create a Project Template	createProjectTemplate
Interact with RStudio's Dictionaries	dictionaries dictionariesPath userDictionariesPath
Create a Document Position	as.document_position document_position is.document_position
Create a Range	as.document_range document_range is.document_range
Execute Command	executeCommand
Select a file / folder	file-dialogs selectDirectory selectFile
Navigate to a Directory in the Files Pane	filesPaneNavigate
Find OAuth Integration by Criteria	findOAuthIntegration
Retrieve path to active RStudio project	getActiveProject
OAuth2 Tokens for Delegated Azure Resources	getDelegatedAzureToken
Get the User's Identity Token	getIdentityToken
Report whether RStudio Desktop or RStudio Server is in use	getMode
Retrieve OAuth Credentials for Integrations	getOAuthCredentials
Get a Specific OAuth Integration	getOAuthIntegration
Get OAuth Integrations	getOAuthIntegrations
Get RStudio Package Dependencies	getRStudioPackageDependencies
Retrieve Themes	getThemeInfo
Get Theme List	getThemes
Determine the version of RStudio	getVersion
Check if console supports ANSI color escapes.	hasColorConsole
Exists/get for RStudio functions	findFun hasFun
Highlight UI Elements within the RStudio IDE	highlightUi
Check if RStudio is running	isAvailable verifyAvailable
Detect RStudio Jobs	isBackgroundJob isJob isWorkbenchJob
Add a Job	jobAdd
Add Background Job Output	jobAddOutput
Add Background Job Progress	jobAddProgress
Get Background Job State	jobGetState
List Background Jobs	jobList
Remove a Background Job	jobRemove
Run R Script As Background Job	jobRunScript
Set Background Job Progress	jobSetProgress
Set Background Job State	jobSetState
Set Background Job Status	jobSetStatus
Check if Workbench Launcher is Available	launcherAvailable
Define a Workbench Launcher Configuration	launcherConfig
Define a Workbench Launcher Container	launcherContainer
Interact with (Control) a Workbench Job	launcherControlJob
Retrieve Workbench Launcher Information	launcherGetInfo
Retrieve Workbench Job Information	launcherGetJob
Retrieve Workbench Job Information	launcherGetJobs
Define a Workbench Launcher Host Mount	launcherHostMount
Define a Workbench Launcher NFS Mount	launcherNfsMount
Define a Workbench Launcher Placement Constraint	launcherPlacementConstraint
Define a Workbench Launcher Resource Limit	launcherResourceLimit
Submit a Workbench Job	launcherSubmitJob
Execute an R Script as a Workbench Job	launcherSubmitR
Navigate to file	navigateToFile
Persistent keys and values	getPersistentValue persistent-values setPersistentValue
Preview an Rd topic in the Help pane	previewRd
Preview SQL statement	previewSql
Extract the Primary Selection	primary_selection
Open a project in RStudio	initializeProject openProject projects
Read Preference	readPreference
Read RStudio Preference	readRStudioPreference
Register Command Callback	registerCommandCallback
Register Command Stream Callback	registerCommandStreamCallback
Remove a custom theme from RStudio.	removeTheme
Restart the R Session	restartSession
Interact with Documents open in RStudio	documentClose documentId documentNew documentOpen documentPath documentSave documentSaveAll insertText modifyRange rstudio-documents setCursorPosition setDocumentContents setSelectionRanges
Retrieve Information about an RStudio Editor	getActiveDocumentContext getConsoleEditorContext getSourceEditorContext rstudio-editors
Save active RStudio plot image	savePlotAsImage
Manipulate User Selections in the RStudio IDE	selectionGet selections selectionSet
Send code to the R console	sendToConsole
Set ghost text	setGhostText
Show Dialog Box	showDialog
Show an Edit Suggestion in RStudio	showEditSuggestion
Show Prompt Dialog Box	showPrompt
Show Question Dialog Box	showQuestion
Display source markers	sourceMarkers
Get System Username	systemUsername
Activate Terminal	terminalActivate
Get Terminal Buffer	terminalBuffer
Is Terminal Busy	terminalBusy
Clear Terminal Buffer	terminalClear
Retrieve Information about RStudio Terminals	terminalContext
Create a Terminal	terminalCreate
Execute Command	terminalExecute
Terminal Exit Code	terminalExitCode
Kill Terminal	terminalKill
Get All Terminal Ids	terminalList
Is Terminal Running	terminalRunning
Send Text to a Terminal	terminalSend
Get Visible Terminal	terminalVisible
Translate Local URL	translateLocalUrl
Unregister Command Callback	unregisterCommandCallback
Updates a Dialog Box	updateDialog
Get User Identity	userIdentity
RStudio version information	versionInfo
View local web content within RStudio	viewer
Write Preference	writePreference
Write RStudio Preference	writeRStudioPreference

Package: rstudioapi 0.19.0.9000

rstudioapi: Safely Access the RStudio API

Citation

Development and contributors

Readme and manuals

Help Manual

Usage by other packages (reverse dependencies)