Package: rstudioapi 0.16.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.16.0.9000.tar.gz
rstudioapi_0.16.0.9000.zip(r-4.5)rstudioapi_0.16.0.9000.zip(r-4.4)rstudioapi_0.16.0.9000.zip(r-4.3)
rstudioapi_0.16.0.9000.tgz(r-4.4-any)rstudioapi_0.16.0.9000.tgz(r-4.3-any)
rstudioapi_0.16.0.9000.tar.gz(r-4.5-noble)rstudioapi_0.16.0.9000.tar.gz(r-4.4-noble)
rstudioapi_0.16.0.9000.tgz(r-4.4-emscripten)rstudioapi_0.16.0.9000.tgz(r-4.3-emscripten)
rstudioapi.pdf |rstudioapi.html
rstudioapi/json (API)
NEWS

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

Peer review:

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

On CRAN:

123 exports 164 stars 16.09 score 0 dependencies 3352 dependents

Last updated 2 months agofrom:a98549272c1b7a782e7578306b824f785410ff7a

Exports:addThemeapplyThemeas.document_positionas.document_rangeaskForPasswordaskForSecretbugReportbuildToolsCheckbuildToolsExecbuildToolsInstallcallFunconvertThemecreateProjectTemplatedictionariesPathdocument_positiondocument_rangedocumentClosedocumentIddocumentNewdocumentOpendocumentPathdocumentSavedocumentSaveAllexecuteCommandfilesPaneNavigatefindFungetActiveDocumentContextgetActiveProjectgetConsoleEditorContextgetDelegatedAzureTokengetPersistentValuegetRStudioPackageDependenciesgetSourceEditorContextgetThemeInfogetThemesgetVersionhasColorConsolehasFunhighlightUiinitializeProjectinsertTextis.document_positionis.document_rangeisAvailableisBackgroundJobisJobisWorkbenchJobjobAddjobAddOutputjobAddProgressjobGetStatejobListjobRemovejobRunScriptjobSetProgressjobSetStatejobSetStatuslauncherAvailablelauncherConfiglauncherContainerlauncherControlJoblauncherGetInfolauncherGetJoblauncherGetJobslauncherHostMountlauncherNfsMountlauncherPlacementConstraintlauncherResourceLimitlauncherSubmitJoblauncherSubmitRmodifyRangenavigateToFileopenProjectpreviewRdpreviewSqlprimary_selectionreadPreferencereadRStudioPreferenceregisterChunkCallbackregisterCommandCallbackregisterCommandStreamCallbackremoveThemerestartSessionsavePlotAsImageselectDirectoryselectFileselectionGetselectionSetsendToConsolesetCursorPositionsetDocumentContentssetGhostTextsetPersistentValuesetSelectionRangesshowDialogshowPromptshowQuestionsourceMarkerssystemUsernameterminalActivateterminalBufferterminalBusyterminalClearterminalContextterminalCreateterminalExecuteterminalExitCodeterminalKillterminalListterminalRunningterminalSendterminalVisibletranslateLocalUrlunregisterChunkCallbackunregisterCommandCallbackupdateDialoguserDictionariesPathuserIdentityverifyAvailableversionInfoviewerwritePreferencewriteRStudioPreference

Dependencies:

Document Manipulation

Rendered fromdocument-manipulation.Rmdusingknitr::rmarkdownon May 31 2024.

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

File Dialogs

Rendered fromdialogs.Rmdusingknitr::rmarkdownon May 31 2024.

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

Interact with the R Session

Rendered fromr-session.Rmdusingknitr::rmarkdownon May 31 2024.

Last update: 2021-02-04
Started: 2017-07-20

Interacting with RStudio Projects

Rendered fromprojects.Rmdusingknitr::rmarkdownon May 31 2024.

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

Interacting with Terminals

Rendered fromterminal.Rmdusingknitr::rmarkdownon May 31 2024.

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

Interfacing with RStudio in Visual Mode

Rendered fromvisual-mode.Rmdusingknitr::rmarkdownon May 31 2024.

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

Introduction to rstudioapi

Rendered fromintroduction.Rmdusingknitr::rmarkdownon May 31 2024.

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

Readme and manuals

Help Manual

Help pageTopics
Add a Custom Editor ThemeaddTheme
Apply an Editor Theme to RStudioapplyTheme
Ask the user for a password interactivelyaskForPassword
Prompt user for secretaskForSecret
File an RStudio Bug ReportbugReport
Build Toolsbuild-tools buildToolsCheck buildToolsExec buildToolsInstall
Call an RStudio API functioncallFun
Register and Unregister a Chunk Callbackchunk-callbacks registerChunkCallback unregisterChunkCallback
Convert a tmTheme to an RStudio ThemeconvertTheme
Create a Project TemplatecreateProjectTemplate
Interact with RStudio's Dictionariesdictionaries dictionariesPath userDictionariesPath
Create a Document Positionas.document_position document_position is.document_position
Create a Rangeas.document_range document_range is.document_range
Execute CommandexecuteCommand
Select a file / folderfile-dialogs selectDirectory selectFile
Navigate to a Directory in the Files PanefilesPaneNavigate
Retrieve path to active RStudio projectgetActiveProject
OAuth2 Tokens for Delegated Azure ResourcesgetDelegatedAzureToken
Get RStudio Package DependenciesgetRStudioPackageDependencies
Retrieve ThemesgetThemeInfo
Get Theme ListgetThemes
Return the current version of the RStudio APIgetVersion
Check if console supports ANSI color escapes.hasColorConsole
Exists/get for RStudio functionsfindFun hasFun
Highlight UI Elements within the RStudio IDEhighlightUi
Check if RStudio is runningisAvailable verifyAvailable
Detect RStudio JobsisBackgroundJob isJob isWorkbenchJob
Add a JobjobAdd
Add Background Job OutputjobAddOutput
Add Background Job ProgressjobAddProgress
Get Background Job StatejobGetState
List Background JobsjobList
Remove a Background JobjobRemove
Run R Script As Background JobjobRunScript
Set Background Job ProgressjobSetProgress
Set Background Job StatejobSetState
Set Background Job StatusjobSetStatus
Check if Workbench Launcher is AvailablelauncherAvailable
Define a Workbench Launcher ConfigurationlauncherConfig
Define a Workbench Launcher ContainerlauncherContainer
Interact with (Control) a Workbench JoblauncherControlJob
Retrieve Workbench Launcher InformationlauncherGetInfo
Retrieve Workbench Job InformationlauncherGetJob
Retrieve Workbench Job InformationlauncherGetJobs
Define a Workbench Launcher Host MountlauncherHostMount
Define a Workbench Launcher NFS MountlauncherNfsMount
Define a Workbench Launcher Placement ConstraintlauncherPlacementConstraint
Define a Workbench Launcher Resource LimitlauncherResourceLimit
Submit a Workbench JoblauncherSubmitJob
Execute an R Script as a Workbench JoblauncherSubmitR
Navigate to filenavigateToFile
Persistent keys and valuesgetPersistentValue persistent-values setPersistentValue
Preview an Rd topic in the Help panepreviewRd
Preview SQL statementpreviewSql
Extract the Primary Selectionprimary_selection
Open a project in RStudioinitializeProject openProject projects
Read PreferencereadPreference
Read RStudio PreferencereadRStudioPreference
Register Command CallbackregisterCommandCallback
Register Command Stream CallbackregisterCommandStreamCallback
Remove a custom theme from RStudio.removeTheme
Restart the R SessionrestartSession
Interact with Documents open in RStudiodocumentClose documentId documentNew documentOpen documentPath documentSave documentSaveAll insertText modifyRange rstudio-documents setCursorPosition setDocumentContents setSelectionRanges
Retrieve Information about an RStudio EditorgetActiveDocumentContext getConsoleEditorContext getSourceEditorContext rstudio-editors
Save active RStudio plot imagesavePlotAsImage
Manipulate User Selections in the RStudio IDEselectionGet selections selectionSet
Send code to the R consolesendToConsole
Set ghost textsetGhostText
Show Dialog BoxshowDialog
Show Prompt Dialog BoxshowPrompt
Show Question Dialog BoxshowQuestion
Display source markerssourceMarkers
Get System UsernamesystemUsername
Activate TerminalterminalActivate
Get Terminal BufferterminalBuffer
Is Terminal BusyterminalBusy
Clear Terminal BufferterminalClear
Retrieve Information about RStudio TerminalsterminalContext
Create a TerminalterminalCreate
Execute CommandterminalExecute
Terminal Exit CodeterminalExitCode
Kill TerminalterminalKill
Get All Terminal IdsterminalList
Is Terminal RunningterminalRunning
Send Text to a TerminalterminalSend
Get Visible TerminalterminalVisible
Translate Local URLtranslateLocalUrl
Unregister Command CallbackunregisterCommandCallback
Updates a Dialog BoxupdateDialog
Get User IdentityuserIdentity
RStudio version informationversionInfo
View local web content within RStudioviewer
Write PreferencewritePreference
Write RStudio PreferencewriteRStudioPreference