In codecheckers/codecheck: Helper Functions for CODECHECK Project

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

codecheck

codecheck is an assistant for conducting CODECHECKs, written in the R language and distributed as an R package. The goal of codecheck is to ease the process to create a CODECHECK-ready workspace, and to conduct the actual CODECHECK. Furthermore, the package contains some helper functions for managing the CODECHECK register.

Learn more about CODECHECK on https://codecheck.org.uk/.

Installation

The package is not on CRAN yet. Install the development version from GitHub with:

# install.packages("remotes")
remotes::install_github("codecheckers/codecheck")

Usage

See the main vignette.

Development

The package uses tinytest for tests. Run test_all("/path/to/package") to run all tests interactively. Even better, run the tests in a fresh install/temporary directory using

# assuming . is the package path
build_install_test(".")

License

Copyright 2022 S. Eglen & D. Nüst. The codecheck package is published under the MIT license, see file LICENSE.

codecheckers/codecheck documentation built on Dec. 6, 2024, 7:38 p.m.