Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/miraisolutions/compareWith
RStudio Addins for Enhanced Diff and Merge
https://github.com/miraisolutions/compareWith
compare r rstudio vcs
Last synced: 3 months ago
JSON representation
RStudio Addins for Enhanced Diff and Merge
- Host: GitHub
- URL: https://github.com/miraisolutions/compareWith
- Owner: miraisolutions
- Created: 2019-03-04T14:43:32.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-30T15:19:40.000Z (3 months ago)
- Last Synced: 2024-07-30T19:22:07.282Z (3 months ago)
- Topics: compare, r, rstudio, vcs
- Language: R
- Homepage:
- Size: 5.01 MB
- Stars: 55
- Watchers: 9
- Forks: 11
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - miraisolutions/compareWith - RStudio Addins for Enhanced Diff and Merge (R)
README
# compareWith: RStudio Addins for Enhanced Diff and Merge
[](https://github.com/miraisolutions/compareWith/actions/workflows/ci.yaml)
**compareWith** is an R package providing user-friendly [RStudio addins](https://rstudio.github.io/rstudioaddins/) that make it easier to perform **diff** and **merge** tasks, compared to the limited functionality offered by RStudio itself, especially with projects under version control.
Tasks **compareWith** greatly helps with include:
- Compare differences prior to commit, for individual files or the whole project.
- Inspect and resolve merge conflicts via three-way comparison.
- Compare two distinct files with each other.
The package relies on [**Meld**](http://meldmerge.org/), a common visual diff and merge tool.
## Installation
You can install the latest released version of **compareWith** from GitHub using the [**remotes**](https://CRAN.R-project.org/package=remotes) package
``` r
remotes::install_github("miraisolutions/compareWith@*release")
```
The development version of **compareWith** is also available for installation via
``` r
remotes::install_github("miraisolutions/compareWith")
```
The required dependency [Meld](http://meldmerge.org) is available for most Linux/Unix distributions and can be easily installed there, e.g. via `sudo apt-get install meld` on **Debian/Ubuntu**.
On **Windows**, its installation is supported by an MSI installer, downloadable from the Meld website. We recommend using the **3.18.3** installer (as hinted on the website), since newer versions seem to have Gtk issues. After installation, you may have to add the location of the installed `meld.exe` to the `PATH` environment variable.
Meld is not yet officially supported on **MacOS**. However, pre-built binaries [are available](https://github.com/yousseb/meld/releases) as `meldmerge.dmg` images for new and old releases of Meld. We currently recommend using Meld **3.16.0**, as newer versions do not appear to be stable. After installation, you need to make sure `meld` can be launched from the command line, e.g. via:
``` bash
ln -s /Applications/Meld.app/Contents/MacOS/Meld /usr/local/bin/meld
```
Meld can also be installed via MacPorts, Fink or Brew, where you may also have to switch to an older stable version.
## Usage
The functionality of **compareWith** is easily accessible in RStudio using the _Addins_ menu or the _Command Palette_ (`Ctrl`/`Cmd`+`Shift`+`P`). See `help("compareWith-addins", package = "compareWith")` for details and references to the underlying generic comparison functions in the package.
