# revdeprun
[](https://crates.io/crates/revdeprun)
[](https://github.com/nanxstats/revdeprun/actions/workflows/ci.yml)
A command-line tool that automates reverse dependency checking for R packages.
Provision R on Ubuntu, install system dependencies, preinstall revdep
dependency binaries, configure environment context,
and run `xfun::rev_check()` in a single command.
Designed for cloud environments where you need reproducible, isolated test
runs without tedious manual setup.
## Installation
### Prerequisites
Install Rust:
```bash
Install C compiler and linker:
```bash
sudo apt-get update && sudo apt-get install -y build-essential
```
### Install revdeprun
From crates.io (stable release):
```bash
cargo install revdeprun
```
From GitHub (latest development version):
```bash
cargo install --git https://github.com/nanxstats/revdeprun.git
```
**Note**: If `cargo` or `revdeprun` is not found immediately after installation,
restart your shell.
## Environment
Currently, this tool is designed for Ubuntu-based systems and requires:
- Operating system: Ubuntu 22.04 or newer
- Version control: Git on `PATH`
- Network access: To download R, R packages, and repository
- Elevated privileges: `sudo` access for installing R and system deps
Security note: Reverse dependency checks execute arbitrary third-party code.
Run `revdeprun` in temporary, isolated environments such as disposable cloud
instances or containers.
## Usage
Simply point `revdeprun` at your package repository:
```bash
revdeprun https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git
```
The tool installs the current release version of R for Ubuntu and uses
all available CPU cores for installation and checking by default.
System requirements for package dependencies are installed automatically.
Reverse dependencies are resolved with {xfun}, their CRAN binaries are
preinstalled into `revdep/library`, and then `xfun::rev_check()`
runs against that library to minimise compilation time and
avoid "package suggested but not available" failures.
Results are written to `revdep/` within your repository directory.
### Command-line options
```
Usage: revdeprun [OPTIONS] <REPOSITORY>
Arguments:
<REPOSITORY>
Git URL or filesystem path to the target R package repository
Options:
--r-version <R_VERSION>
R version to install: release, oldrel-1, or exact version (e.g., 4.3.3)
[default: release]
--num-workers <N>
Number of parallel workers for xfun::rev_check()
[default: number of CPU cores]
--work-dir <WORK_DIR>
Workspace directory for temporary files and cloned repositories
--skip-r-install
Skip R installation and use the existing system-wide R
-h, --help
Print help information
-V, --version
Print version information
```
## Example workflows
Standard check on a remote repository:
```bash
revdeprun https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git
```
Specify [R version](https://github.com/r-lib/actions/tree/v2-branch/setup-r)
and parallelism:
```bash
revdeprun --r-version devel --num-workers 48 \
https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git
```
Use a custom workspace and SSH authentication:
```bash
revdeprun --work-dir /data/workspace \
git@github.com:YOUR-USERNAME/YOUR-REPOSITORY.git
```
Check a local directory:
```bash
revdeprun ~/workspace/YOUR-REPOSITORY
```
Use an existing R installation:
```bash
revdeprun --skip-r-install https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git
```
## License
This project is licensed under the MIT License.