Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jimhester/lookup
Lookup R full function definitions, including compiled code, S3 and S4 methods.
https://github.com/jimhester/lookup
r
Last synced: 3 days ago
JSON representation
Lookup R full function definitions, including compiled code, S3 and S4 methods.
- Host: GitHub
- URL: https://github.com/jimhester/lookup
- Owner: jimhester
- License: other
- Created: 2016-05-16T22:33:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-11-30T19:58:29.000Z (about 1 year ago)
- Last Synced: 2024-12-13T06:02:52.039Z (10 days ago)
- Topics: r
- Language: R
- Homepage:
- Size: 150 KB
- Stars: 212
- Watchers: 5
- Forks: 11
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# lookup
> Lookup R function definitions, including compiled code, S3 and S4 methods
> from packages installed locally, or from [GitHub](http://rpkg.gepuro.net/),
> [CRAN](https://cran.r-project.org) or
> [Bioconductor](https://www.bioconductor.org).
[](https://travis-ci.org/jimhester/lookup)
[](https://codecov.io/github/jimhester/lookup?branch=master)
## Installation
```r
# install.packages("devtools")
devtools::install_github("jimhester/lookup")
```
See [Setup](#setup) for additional setup instructions.
## Example
### Normal Functions (with compiled code)
### S3 generics and methods
### S4 generics and methods
### In RStudio IDE
## Usage
```r
# Lookup a function
lookup::lookup(body)
#> base::body [closure]
#> function (fun = sys.function(sys.parent()))
#> {
#> if (is.character(fun))
#> fun <- get(fun, mode = "function", envir = parent.frame())
#> .Internal(body(fun))
#> }
#>
#>
#> // c source: src/main/builtin.c#L255-L266
#> SEXP attribute_hidden do_body(SEXP call, SEXP op, SEXP args, SEXP rho)
#> {
#> checkArity(op, args);
#> if (TYPEOF(CAR(args)) == CLOSXP)
#> return duplicate(BODY_EXPR(CAR(args)));
#> else {
#> if(!(TYPEOF(CAR(args)) == BUILTINSXP ||
#> TYPEOF(CAR(args)) == SPECIALSXP))
#> warningcall(call, _("argument is not a function"));
#> return R_NilValue;
#> }
#> }
# Can also open a browser at that function's location
lookup_browse()
```
## Setup
lookup makes heavy use of the [GitHub API](https://developer.github.com/v3/),
which has a rate limit of [60 requests per
hour](https://developer.github.com/v3/#rate-limiting) when unauthenticated. You
can create a [Personal access token](https://github.com/settings/tokens) with
no scope, which will increase your limit to 5000 requests per hour.
The usethis package has a helper function to help you generate such a token, [`usethis::browse_github_token()`](https://usethis.r-lib.org/reference/browse_github_token.html).
Once you have generated a token, add it to your `~/.Renviron` file or shell
startup file and it will be automatically used for further requests.
```
GITHUB_PAT=7d8d0436835d1baXYZ1234
```
`gh::gh("/rate_limit")` can be used to query your current usage and limits.
## Default printing
lookup can be used as a complete replacement for function printing by attaching
the package. To make this the default simply add this to your `.Rprofile`.
```r
if (interactive()) {
suppressPackageStartupMessages(library(lookup))
}
```
If you do not want make this the default simply call `lookup::lookup()`.
# How this works
If a base R function is printed that calls compiled code the code is looked up
using the [R git mirror](https://github.com/wch/r-source). If a CRAN package
has compiled code it is looked up on the [CRAN git
mirror](https://github.com/cran). If a package is installed with
`devtools::install_github()` or `devtools::install()` the remote or local
repository location is searched for the code.
This has been tested to work with `.Internal`, `.External`, `.C`, `.Call` and
[Rcpp](https://github.com/RcppCore/Rcpp) calls.
## Issues ##
This package uses a number of heuristics to find function definitions. This
means it can fail in some cases, if you find a function that is not looked up
properly, please [open an issue](https://github.com/jimhester/lookup/issues).
## Thanks ##
- [R Core and Community](https://www.r-project.org) For promoting open source software to make this possible.
- [Winston Chang](https://github.com/wch) For running the [Git mirror of the R Source](https://github.com/wch/r-source).
- [Gábor Csárdi](https://github.com/gaborcsardi) For the [gh](https://github.com/r-pkgs/gh) package, the [CRAN git mirror](https://github.com/cran) and inspiration and code for handling pagination and busy updating.
- [Jenny Bryan](https://github.com/jennybc) For codifying the process of [accessing the R source](https://github.com/jennybc/access-r-source), which was my main inspiration and motivation for starting this package.
- [Hadley Wickham](https://github.com/hadley) For writing `pryr::show_c_source()` which provides a simplified version of looking up internal and primitive calls and additional prior functions to test for S3 method and generic membership.