README.md

Features

Installation

pak::pkg_install("r-lib/revdepcheck")

Usage

library(revdepcheck)

Check package in working directory, creating "revdep/" directory if it doesn't already exist:

revdep_check(num_workers = 4)

If the run fails to complete, run again and it will pick up where it left off:

revdep_check(num_workers = 4)

During execution, run these in a separate R process to view status completed checks:

revdep_summary()                 # table of results by package 
revdep_details(".", "<package>") # full details for the specified package

Generate human-friendly summary documents in revdep/:

revdep_report()
## Writing *partial* report
## Writing summary to 'revdep/README.md'
## Writing problems to 'revdep/problems.md'
## Writing failures to 'revdep/failures.md'

Manage a "todo" list of packages to examine:

revdep_add(pkg = ".", <packages>)  # add <packages> to the list
revdep_rm(pkg = ".", <packages>).  # remove <packages> from list

revdep_add_broken()  # add all broken packages
revdep_add_new()     # add newly available packages
revdep_todo()        # list packages in the todo list

Clear out all previous results

revdep_reset()

We recommend running revdep_check() in a separate process (e.g. new terminal under RStudio). That way, while it runs in a background tab, you can easily use your revdep_details(revdep = "pkg") to see what's gone wrong with "pkg".

Status Flags:

License

MIT © Gábor Csárdi, R Consortium, RStudio Inc



r-lib/revdepcheck documentation built on Oct. 22, 2024, 2:13 a.m.