Git Product home page Git Product logo

revdepcheck's Introduction

revdepcheck

Automated, Isolated, Reverse Dependency Checking

R-CMD-check Codecov test coverage CRAN RStudio mirror downloads

Features

  • To avoid false positives due to existing failures, revdepcheck runs R CMD check twice for each revdep, once with the CRAN version of your package, and once with the local development version. revdepcheck reports the difference, so you can see exactly what has changed.

  • To speed up installation of revdeps and their dependencies, revdepcheck relies on crancache. You can see what packages are currently cached with crancache::crancache_list().

  • revdepcheck is carefully designed to make long running checks as pleasant as possible. You run checks in parallel, check time is limited to 10 minutes, and an elegant progress bar keeps you up-to-date with what's happening (including an estimate of how much time is remaining).

Installation

This package is not available on CRAN yet. Install it with:

devtools::install_github('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:

  • install newly fails: i-
  • install still fails: i+
  • install/check newly timeouts: t-
  • install/check still timeouts: t+
  • No new failures, success: +
  • Some new failures: -

License

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

revdepcheck's People

Contributors

gaborcsardi avatar hadley avatar jimhester avatar krlmlr avatar jennybc avatar ateucher avatar etiennebacher avatar lionel- avatar davisvaughan avatar henrikbengtsson avatar romainfrancois avatar adamhsparks avatar fmichonneau avatar warnes avatar llrs avatar lbergelson avatar bertcarnell avatar stevenolen avatar vspinu avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.