rstudioapi

Safely access RStudio's API (when available)

https://github.com/rstudio/rstudioapi

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
○
.zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (17.7%) to scientific vocabulary

Keywords from Contributors

rmarkdown pandoc shiny latex literate-programming web-development web-app gitbook epub book

Last synced: 10 months ago · JSON representation

Repository

Safely access RStudio's API (when available)

Basic Info

Host: GitHub
Owner: rstudio
License: other
Language: R
Default Branch: main
Homepage: http://rstudio.github.io/rstudioapi
Size: 1.07 MB

Statistics

Stars: 172
Watchers: 55
Forks: 37
Open Issues: 137
Releases: 1

Created over 12 years ago · Last pushed over 1 year ago

Metadata Files

Readme Changelog License

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# rstudioapi 



[![CRAN status](https://www.r-pkg.org/badges/version/rstudioapi)](https://CRAN.R-project.org/package=rstudioapi)
[![Codecov test coverage](https://codecov.io/gh/rstudio/rstudioapi/branch/main/graph/badge.svg)](https://app.codecov.io/gh/rstudio/rstudioapi?branch=main)
[![R-CMD-check](https://github.com/rstudio/rstudioapi/workflows/R-CMD-check/badge.svg)](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)
```

Owner

Name: RStudio
Login: rstudio
Kind: organization
Email: info@rstudio.org
Location: Boston, MA

Website: http://rstudio.org
Repositories: 356
Profile: https://github.com/rstudio

GitHub Events

Total

Create event: 1
Release event: 1
Issues event: 16
Watch event: 6
Issue comment event: 23
Push event: 8
Pull request event: 5
Fork event: 2

Last Year

Create event: 1
Release event: 1
Issues event: 16
Watch event: 6
Issue comment event: 23
Push event: 8
Pull request event: 5
Fork event: 2

Committers

Last synced: about 1 year ago

All Time

Total Commits: 349
Total Committers: 23
Avg Commits per committer: 15.174
Development Distribution Score (DDS): 0.533

Past Year

Commits: 11
Committers: 2
Avg Commits per committer: 5.5
Development Distribution Score (DDS): 0.091

Top Committers

Name	Email	Commits
Kevin Ushey	k**y@g**m	163
JJ Allaire	jj@r****g	33
Gary Ritchie	g**y@r**m	30
Jonathan McPherson	j**n@r**m	24
Javier Luraschi	j**i@h**m	20
hadley	h**m@g**m	19
Jackie Gutman	j**n@r**m	15
melissa-barca	m**a@r**m	10
Andrie	a**s@g**m	8
AshesITR	r**t@y**e	5
Maria Semple	m**a@r**m	5
Jenny Bryan	j**n@g**m	4
olivroy	5****y	2
Romain Francois	r**n@r**m	2
Tim Mok	t**k@r**m	1
Aaron Jacobs	a**s@r**m	1
Michael Chirico	c**m@g**m	1
Randy Zwitch	r**h@p**o	1
Salim B	g**t@s**e	1
Yihui Xie	x**e@y**e	1
mutterer	j**r@g**m	1
shrektan	s**n@1**m	1
trestletech	g**b@t**m	1

Committer Domains (Top 20 + Academic)

rstudio.com: 8 trestletech.com: 1 126.com: 1 yihui.name: 1 salim.space: 1 posit.co: 1 google.com: 1 yahoo.de: 1 rstudio.org: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time

Total issues: 82
Total pull requests: 66
Average time to close issues: about 1 year
Average time to close pull requests: 16 days
Total issue authors: 63
Total pull request authors: 21
Average comments per issue: 2.0
Average comments per pull request: 1.05
Merged pull requests: 55
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 12
Pull requests: 3
Average time to close issues: 2 days
Average time to close pull requests: 19 days
Issue authors: 11
Pull request authors: 3
Average comments per issue: 0.92
Average comments per pull request: 1.67
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

gadenbuie (5)
vnijs (3)
MilesMcBain (3)
jennybc (3)
jthomasmock (2)
vincentarelbundock (2)
howardbaik (2)
rjake (2)
olivroy (2)
daattali (2)
DavisVaughan (2)
hadley (2)
dipterix (2)
LuisLauM (1)
greenjune-ship-it (1)

Pull Request Authors

kevinushey (18)
jmcphers (12)
javierluraschi (6)
jgutman (5)
gtritchie (4)
jjallaire (4)
MariaSemple (3)
olivroy (3)
romainfrancois (2)
coatless (2)
sgolde13 (2)
jonovik (2)
randyzwitch (2)
MichaelChirico (2)
jameslairdsmith (2)

Top Labels

Issue Labels

enhancement (6) bug (4) backlog (3) documentation (2) rstudioapi (1) workbench (1) projects (1) duplicate (1) builds (1) triage (1)

Pull Request Labels

Packages

Total packages: 3
Total downloads:
- cran 567,583 last-month
Total docker downloads: 162,038,697

Total dependent packages: 479
(may contain duplicates)
Total dependent repositories: 1,654
(may contain duplicates)
Total versions: 28
Total maintainers: 1

cran.r-project.org: rstudioapi

Safely Access the RStudio API

Homepage: https://rstudio.github.io/rstudioapi/
Documentation: http://cran.r-project.org/web/packages/rstudioapi/rstudioapi.pdf
License: MIT + file LICENSE
Latest release: 0.17.1
published over 1 year ago

Versions: 18
Dependent Packages: 420
Dependent Repositories: 1,587
Downloads: 567,583 Last month
Docker Downloads: 162,038,697

Rankings

Dependent repos count: 0.3%

Dependent packages count: 0.3%

Downloads: 0.4%

Forks count: 2.4%

Stargazers count: 2.6%

Average: 3.9%

Docker downloads count: 17.3%

Maintainers (1)

kevin@rstudio.com

Last synced: 11 months ago

proxy.golang.org: github.com/rstudio/rstudioapi

Documentation: https://pkg.go.dev/github.com/rstudio/rstudioapi#section-documentation
License: other
Latest release: v0.17.0
published over 1 year ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.5%

Average: 5.7%

Dependent repos count: 5.9%

Last synced: 11 months ago

conda-forge.org: r-rstudioapi

Homepage: https://github.com/rstudio/rstudioapi
License: MIT
Latest release: 0.9.0
published over 7 years ago

Versions: 9
Dependent Packages: 59
Dependent Repositories: 67

Rankings

Dependent packages count: 1.3%

Dependent repos count: 4.2%

Average: 16.0%

Stargazers count: 28.8%

Forks count: 29.7%

Last synced: 11 months ago

Dependencies

DESCRIPTION cran

clipr * suggests
covr * suggests
knitr * suggests
rmarkdown * suggests
testthat * suggests