Skip to content
Safely access RStudio's API (when available)
Branch: master
Clone or download
Latest commit faea00b Mar 6, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R
docs
man
tests provide 'setDocumentContents' API Dec 3, 2015
vignettes tweaks to terminal vignette and docs Aug 28, 2017
.Rbuildignore documentation Jan 18, 2019
.gitignore
.travis.yml
DESCRIPTION release 0.9.0 Jan 11, 2019
LICENSE various changes for R CMD check Apr 6, 2015
NAMESPACE
NEWS.md
README.md Update travis badge May 31, 2017
_pkgdown.yml add pkgdown.yml Aug 24, 2017
rstudioapi.Rproj vignette tweaks Jul 20, 2017

README.md

rstudioapi

Travis-CI Build Status

The rstudioapi package is designed to make it easy to conditionally access the RStudio 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")

Example uses

# rstudioapi is designed to never be attached to your search path.
# Always prefix function calls with rstudioapi::

# 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)

Installation

  • Install the development version with devtools::install_github("rstudio/rstudioapi").
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.