Skip to content

R package assistant for conducting a CODECHECK

License

Notifications You must be signed in to change notification settings

codecheckers/codecheck

Folders and files

NameName
Last commit message
Last commit date

Latest commit

4ac2111 · Feb 20, 2025
Nov 13, 2024
Feb 20, 2025
Feb 20, 2025
Jan 6, 2025
Sep 2, 2020
Dec 20, 2024
Jun 13, 2022
Jun 19, 2020
Feb 9, 2021
Feb 9, 2021
Feb 20, 2025
Apr 18, 2020
Dec 20, 2024
Sep 2, 2020
Oct 11, 2022
Aug 20, 2024
Dec 20, 2024

Repository files navigation

codecheck

Lifecycle: experimental R build status DOI

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 2024 S. Eglen & D. Nüst. The codecheck package is published under the MIT license, see file LICENSE.