https://github.com/cynkra/collector
What the Package Does (One Line, Title Case)
https://github.com/cynkra/collector
Last synced: 7 months ago
JSON representation
What the Package Does (One Line, Title Case)
- Host: GitHub
- URL: https://github.com/cynkra/collector
- Owner: cynkra
- Created: 2024-04-02T19:07:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-29T19:46:09.000Z (over 1 year ago)
- Last Synced: 2025-03-16T01:54:21.667Z (7 months ago)
- Language: R
- Size: 33.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.Rmd
Awesome Lists containing this project
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# collector
draft for discussion
## Installation
Install with
```
pak::pak("cynkra/collector")
```
## Examples
`collector()` creates a new function, with an altered body but the same environment:
```{r}
library(collector)
add <- function(x, y) {
x + y
}
environment(add) <- asNamespace("stats")
add2 <- collector(add)
add2
```
It behaves the same as the original but additionally it collects :
* The arguments
* The call
* The return value
```{r}
a <- 1
b <- 2
add2(a, b)
collected("add")
```
Note the use of `delayedAssign()` because arguments are not evaluated yet
at the start of the body, this is robust to functions that use NSE.
If we know we don't use NSE, we can use `force = TRUE`
```{r}
# if we
add3 <- collector(add, force = TRUE, name = "custom_name")
add3(a, b)
collected("custom_name")
```
Or we can choose
```{r}
# if we
add4 <- collector(add, force = "x", name = "custom_name2")
add4(a, b)
collected("custom_name2")
```