revdeprun 0.1.0

One-key reverse dependency checks for R via revdepcheck with cloud-ready environment setup
Documentation 
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

# revdeprun

[![crates.io version](https://img.shields.io/crates/v/revdeprun)](https://crates.io/crates/revdeprun)
[![CI tests](https://github.com/nanxstats/revdeprun/actions/workflows/ci.yml/badge.svg)](https://github.com/nanxstats/revdeprun/actions/workflows/ci.yml)
![License](https://img.shields.io/crates/l/revdeprun)

One-key reverse dependency checks for R via revdepcheck with cloud-ready environment setup.

## Installation

Install system dependencies for building Rust crates
and building R package dependencies of revdepcheck:

```bash
sudo apt-get update
sudo apt-get install -y build-essential libssl-dev libcurl4-openssl-dev
```

[Install Rust](https://rust-lang.org/tools/install/).

Install `revdeprun` from crates.io using Cargo:

```bash
cargo install revdeprun
```

To try the latest development version directly from GitHub:

```bash
cargo install --git https://github.com/nanxstats/revdeprun.git
```

## Requirements

- Ubuntu 20.04 or newer with `sudo` access (tooling uses `apt-get`, `gdebi`, and system-wide `/opt/R` installs).
- Network access to download R binaries, R packages, and the target Git repository.
- Git available on `PATH`.

Running inside a fresh cloud instance is recommended because reverse dependency
checks execute third-party code.

## Usage

The CLI provisions the requested R toolchain, prepares the package repository,
and runs `revdepcheck` end-to-end:

```bash
revdeprun https://github.com/nanxstats/ggsci.git
```

By default, the current release version of R for Ubuntu is installed
and the number of workers is set to use all available CPU cores.

### Command options

```
$ revdeprun --help
Provision R and run revdepcheck end-to-end

Usage: revdeprun [OPTIONS] <REPOSITORY>

Arguments:
  <REPOSITORY>  Git URL or filesystem path pointing to the target R package repository

Options:
      --r-version <R_VERSION>  R version specification to install (e.g. release, 4.3.3, oldrel-1) [default: release]
      --num-workers <N>        Number of parallel workers to pass to revdepcheck
      --work-dir <WORK_DIR>    Optional workspace directory where temporary files are created
      --skip-r-install         Skip installing R and reuse the system-wide installation
  -h, --help                   Print help
  -V, --version                Print version
```

### Typical workflow

1. Provision a clean Ubuntu VM with sufficient CPU and memory.
2. Install `revdeprun` (for example, `cargo install revdeprun`).
3. Run `revdeprun <repo>` with optional flags, such as:
   - `revdeprun --r-version release https://github.com/nanxstats/ggsci.git`
   - `revdeprun --num-workers 48 --work-dir /data/workspace git@github.com:nanxstats/ggsci.git`
4. Review the results under `<repo>/revdep`.

### Notes

- `revdeprun` installs R into `/opt/R/...` and symlinks binaries to `/usr/local/bin`.
- The tool uses the latest development version of revdepcheck via `remotes::install_github("r-lib/revdepcheck")`.
- If you already provision R and required packages, pass `--skip-r-install`.
- To point at a local checkout instead of cloning, supply the path directly:
  `revdeprun ~/workspace/ggsci`.