Data

Tools

Indexes

Applications

Experiments

Open Source Science

checked

batch R CMD check management

https://github.com/genentech/checked

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.0%) to scientific vocabulary

Keywords

checks r revdeps
Last synced: 6 months ago · JSON representation

Repository

batch R CMD check management

Basic Info
Statistics
  • Stars: 8
  • Watchers: 3
  • Forks: 1
  • Open Issues: 17
  • Releases: 0
Topics
checks r revdeps
Created over 1 year ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License

README.Rmd 

---
title: checked
output: github_document
always_allow_html: yes
---



```{r, include = FALSE, cache = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README",
  out.width = "100%",
  asciicast_theme = if (Sys.getenv("IN_PKGDOWN") == "true") {
    "pkgdown"
  } else {
    "readme"
  }
)

asciicast::init_knitr_engine(
  startup = bquote({
    options(repos = .(getOption("repos")))
  }),
  echo_input = FALSE
)
```

> Batch `R CMD check` management


[![R-CMD-check](https://github.com/Genentech/checked/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/Genentech/checked/actions/workflows/R-CMD-check.yaml/badge.svg)
[![CRAN](https://img.shields.io/cran/v/checked.svg)](https://cran.r-project.org/package=checked)
[![coverage](https://codecov.io/gh/Genentech/checked/branch/main/graph/badge.svg)](https://app.codecov.io/gh/Genentech/checked/tree/main)


```{sh clone-dev-praise, echo = FALSE, results = "hide"}
# praise chosen for having few direct and reverse dependencies
rm -rf /tmp/praise
git clone https://github.com/gaborcsardi/praise /tmp/praise
```

# Running Checks

Although `checked` is broadly capable of running arbitrary sets of `R CMD check`
tasks, reverse dependency checking is one of the most common use cases where
batch `R CMD check`s are needed. 

Running reverse dependency checks is as easy as

```r
library(checked)
x <- run("/home/dev/praise")
results(x)
```
```{r, echo = FALSE}
library(checked)
x <- run("/tmp/praise", reporter = NULL)
results(x)
```

## Monitoring Runs

Because running many checks in parallel can be a difficult process to monitor,
capable interfaces will provide a convenient output for tracking various
runs, check results and package installations; keeping a log of any issues 
that might arise during the process.

If your editor doesn't support the full output, you might consider launching
your checks in a terminal which should be less constrained. This would also
free up your preferred editor for you to use while your checks run.

```r
library(checked)
run("/home/dev/praise")
```
```{asciicast ansi-tty-example, cache = FALSE}
#| asciicast_knitr_output = "svg",
#| asciicast_at = "all",
#| asciicast_cursor = FALSE,
#| asciicast_speed = 2
options(checked.tty_tick_interval = 200)
checked::run("/tmp/praise")
cat()
```

Owner

  • Name: Genentech
  • Login: Genentech
  • Kind: organization
  • Location: South San Francisco, CA

GitHub Events

Total
  • Issues event: 15
  • Watch event: 1
  • Delete event: 2
  • Issue comment event: 13
  • Push event: 51
  • Pull request review comment event: 9
  • Pull request review event: 11
  • Pull request event: 20
  • Create event: 12
Last Year
  • Issues event: 15
  • Watch event: 1
  • Delete event: 2
  • Issue comment event: 13
  • Push event: 51
  • Pull request review comment event: 9
  • Pull request review event: 11
  • Pull request event: 20
  • Create event: 12

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 60
  • Total Committers: 2
  • Avg Commits per committer: 30.0
  • Development Distribution Score (DDS): 0.217
Past Year
  • Commits: 60
  • Committers: 2
  • Avg Commits per committer: 30.0
  • Development Distribution Score (DDS): 0.217
Top Committers
Name Email Commits
maksymis 3****s 47
dgkf-roche d****f@r****m 13
Committer Domains (Top 20 + Academic)
roche.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 32
  • Total pull requests: 39
  • Average time to close issues: 13 days
  • Average time to close pull requests: 6 days
  • Total issue authors: 5
  • Total pull request authors: 4
  • Average comments per issue: 0.69
  • Average comments per pull request: 0.85
  • Merged pull requests: 31
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 18
  • Pull requests: 22
  • Average time to close issues: 21 days
  • Average time to close pull requests: 10 days
  • Issue authors: 4
  • Pull request authors: 2
  • Average comments per issue: 1.22
  • Average comments per pull request: 0.77
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • maksymiuks (23)
  • ddsjoberg (7)
  • dgkf-roche (4)
  • dgkf (1)
  • gowerc (1)
Pull Request Authors
  • maksymiuks (43)
  • dgkf-roche (10)
  • HenningLorenzen-ext-bayer (2)
  • olivroy (2)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 538 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 5
  • Total maintainers: 1
cran.r-project.org: checked

Systematically Run R CMD Checks

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 538 Last month
Rankings
Dependent packages count: 28.5%
Dependent repos count: 35.2%
Average: 50.1%
Downloads: 86.6%
Maintainers (1)
sz.maksymiuk@gmail.com
Last synced: 6 months ago

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.5.0 composite
  • actions/checkout v4 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • codecov/codecov-action v4 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION cran
  • R6 * imports
  • callr * imports
  • cli * imports
  • igraph * imports
  • jsonlite * imports
  • rcmdcheck * imports
  • tools * imports
  • utils >= 3.6.2 imports
  • testthat >= 3.0.0 suggests
inst/example_packages/exampleBad/DESCRIPTION cran
  • knitr * suggests
  • rmarkdown * suggests
inst/example_packages/exampleGood/DESCRIPTION cran
  • DBI * imports
  • methods * imports
  • knitr * suggests
  • rmarkdown * suggests
  • testthat * suggests
inst/example_packages/exampleOkay/DESCRIPTION cran
tests/testthat/testing_pkgs/DALEXtra/DESCRIPTION cran
  • DALEX >= 2.4.0 depends
  • R >= 3.5.0 depends
  • ggplot2 * imports
  • auditor * suggests
  • gbm * suggests
  • ggrepel * suggests
  • h2o * suggests
  • iml * suggests
  • ingredients * suggests
  • lime * suggests
  • localModel * suggests
  • mlr * suggests
  • mlr3 * suggests
  • ranger * suggests
  • recipes * suggests
  • reticulate * suggests
  • rmarkdown * suggests
  • rpart * suggests
  • stacks * suggests
  • testthat * suggests
  • tidymodels * suggests
  • xgboost * suggests
tests/testthat/testing_pkgs/rd2markdown/DESCRIPTION cran
  • R >= 3.2.0 depends
  • covr * suggests
  • knitr * suggests
  • rmarkdown * suggests
  • testthat >= 3.0.0 suggests