The hardware and bandwidth for this mirror is donated by dogado GmbH, the Webhosting and Full Service-Cloud Provider. Check out our Wordpress Tutorial.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]dogado.de.

captain

CRAN_Status_Badge R-CMD-check Codecov test coverage

Running R pre-commit hooks

Overview

Pre-commit hooks are scripts that run automatically before a commit is finalized in Git. They’re used to catch issues early by enforcing checks like code formatting, linting, or running tests before changes are committed.

captain (hook) is a package that allows you to run git pre-commit hooks in a R environment.

Installation

The latest version can be installed from GitHub as follows:

# install.packages("pak")
pak::pak("alexym1/captain")

Usage

Initialize pre-commit framework

captain::install_precommit()

Run hooks

captain::run_precommit()

Add hooks

Editing the .pre-commit-config file using captain::edit_precommit_config():

repos:
  - repo: local
    hooks:
      - id: renv
        name: Synchronize project from renv.lock
        description: Synchronize the project from the renv.lock
        entry: Rscript inst/pre-commit/hooks/synchronize_project.R
        language: system
        pass_filenames: false

Code of conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Acknowledgments

This logo was created by @obstacle.graphic.

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.
Health stats visible at Monitor.