Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 431 Commits
.github		.github
R		R
inst/resources		inst/resources
man		man
pkgdown/favicon		pkgdown/favicon
tests		tests
vignettes		vignettes
.Rbuildignore		.Rbuildignore
.gitignore		.gitignore
DESCRIPTION		DESCRIPTION
LICENSE		LICENSE
NAMESPACE		NAMESPACE
NEWS.md		NEWS.md
README.Rmd		README.Rmd
README.md		README.md
_pkgdown.yml		_pkgdown.yml
codecov.yml		codecov.yml
cran-comments.md		cran-comments.md
rstudioapi.Rproj		rstudioapi.Rproj

Repository files navigation

rstudioapi

Therstudioapi package is designed to make it easy to conditionallyaccess theRStudio API from CRAN packages, avoidingany potential problems withR CMD check. This package contains ahandful of useful wrapper functions to access the API. To see thefunctions that are currently available in the API, runhelp(package = "rstudioapi")

Installation

You can install the released version ofrstudioapi fromCRAN with:

install.packages("rstudioapi")

And the development version fromGitHub with:

# install.packages("devtools")devtools::install_github("rstudio/rstudioapi")

Example

Therstudioapi package is designed to never be attached to your searchpath. Always prefix function calls withrstudioapi::.

# Returns T/Frstudioapi::isAvailable()# Returns error if not availablerstudioapi::verifyAvailable()# Optional argument allows you to specify version requirementrstudioapi::isAvailable("0.99")rstudioapi::verifyAvailable("0.99")# Call an rstudio functionrstudioapi::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 existsif (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 findrstudioapi::findFun("viewer",0.99)rstudioapi::hasFun("viewer",0.99)