https://github.com/rstudio/rstudioapi
Safely access RStudio's API (when available)
https://github.com/rstudio/rstudioapi
Last synced: 7 days ago
JSON representation
Safely access RStudio's API (when available)
- Host: GitHub
- URL: https://github.com/rstudio/rstudioapi
- Owner: rstudio
- License: other
- Created: 2014-01-10T11:37:40.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2024-11-04T18:45:37.000Z (5 months ago)
- Last Synced: 2025-03-31T19:04:19.145Z (14 days ago)
- Language: R
- Homepage: http://rstudio.github.io/rstudioapi
- Size: 1.07 MB
- Stars: 172
- Watchers: 55
- Forks: 37
- Open Issues: 136
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - rstudio/rstudioapi - Safely access RStudio's API (when available) (R)
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# rstudioapi 
[](https://CRAN.R-project.org/package=rstudioapi)
[](https://app.codecov.io/gh/rstudio/rstudioapi?branch=main)
[](https://github.com/rstudio/rstudioapi/actions)
The `rstudioapi` package is designed to make it easy to conditionally access the
[RStudio](https://posit.co/) API from CRAN packages, avoiding any
potential problems with `R CMD check`. This package contains a handful of useful
wrapper functions to access the API. To see the functions that are currently
available in the API, run `help(package = "rstudioapi")`
## Installation
You can install the released version of `rstudioapi` from [CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("rstudioapi")
```
And the development version from [GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("rstudio/rstudioapi")
```
## Example
The `rstudioapi` package is designed to never be attached to your search path.
Always prefix function calls with `rstudioapi::`.
```R
# Returns T/F
rstudioapi::isAvailable()
# Returns error if not available
rstudioapi::verifyAvailable()
# Optional argument allows you to specify version requirement
rstudioapi::isAvailable("0.99")
rstudioapi::verifyAvailable("0.99")
# Call an rstudio function
rstudioapi::callFun("viewer", "http://localhost:8080")
# This will raise an error if rstudio is not running, or the function
# is not found. To run a different function if it's not available,
# use exists
if (rstudioapi::hasFun("viewer")) {
rstudioapi::callFun("viewer", "http://localhost:8080")
} else {
browseURL("http://localhost:8080")
}
# You can use find to get the function. Throws an error if the function
# does not exist.
rstudioapi::findFun("viewer")
# You can also check version in exists and find
rstudioapi::findFun("viewer", 0.99)
rstudioapi::hasFun("viewer", 0.99)
```