knitr::opts_chunk$set( collapse = TRUE, comment = "#>", fig.path = "man/figures/README-", out.width = "100%" )
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")
You can install the released version of rstudioapi
from CRAN with:
install.packages("rstudioapi")
And the development version from GitHub with:
# install.packages("devtools") devtools::install_github("rstudio/rstudioapi")
The rstudioapi
package 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)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.