forked from r-lib/conflicted
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
96 lines (66 loc) · 3.55 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
set.seed(1014)
```
# conflicted
<!-- badges: start -->
[](https://github.com/r-lib/conflicted/actions)
[](https://app.codecov.io/gh/r-lib/conflicted?branch=main)
<!-- badges: end -->
The goal of conflicted is to provide an alternative conflict resolution strategy. R's default conflict resolution system gives precedence to the most recently loaded package. This can make it hard to detect conflicts, particularly when introduced by an update to an existing package. conflicted takes a different approach, making every conflict an error and forcing you to choose which function to use.
Thanks to [\@krlmlr](https://github.com/krlmlr) for this neat idea! This code was previously part of the experimental [strict](https://github.com/hadley/strict) package, but I decided improved conflict resolution is useful by itself and worth its own package.
## Installation
```{r, eval = FALSE}
# install.packages("devtools")
devtools::install_github("r-lib/conflicted")
```
## Usage
To use conflicted, all you need to do is load it:
```{r, error = TRUE}
library(conflicted)
library(dplyr)
filter(mtcars, cyl == 8)
```
As suggested, you can either namespace individual calls:
```{r}
dplyr::filter(mtcars, am & cyl == 8)
```
Or declare a session-wide preference:
```{r}
conflict_prefer("filter", "dplyr")
filter(mtcars, am & cyl == 8)
```
I recommend declaring preferences directly underneath the corresponding library call:
```{r, eval = FALSE}
library(dplyr)
conflict_prefer("filter", "dplyr")
```
You can ask conflicted to report any conflicts in the current session:
```{r}
conflict_scout()
```
Functions surrounded by `[]` have been chosen using one of the built-in rules. Here `filter()` has been selected because of the preference declared above; the set operations have been selected because they follow the superset principle and extend the API of the base equivalents.
### How it works
Loading conflicted creates a new "conflicted" environment that is attached just after the global environment. This environment contains an active binding for any object that is exported by multiple packages; the active binding will throw an error message describing how to disambiguate the name. The conflicted environment also contains bindings for `library()` and `require()` that suppress conflict reporting and update the conflicted environment with any new conflicts.
## Alternative approaches
It is worth comparing conflicted to [modules](http://github.com/klmr/modules) and [import](https://github.com/smbache/import). Both packages provide strict alternatives to `library()`, giving much finer control over what functions are added to the search path.
```{r, eval = FALSE}
# modules expects you to namespace all package functions
dplyr <- modules::import_package('dplyr')
dplyr$filter(mtcars, cyl == 8)
# import expects you to explicit load functions
import::from(dplyr, select, arrange, dplyr_filter = filter)
dplyr_filter(mtcars, cyl == 8)
```
These require more upfront work than conflicted, in return for greater precision and control.
## Code of conduct
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
By participating in this project you agree to abide by its terms.