https://github.com/codecheckers/codecheck

R package assistant for conducting a CODECHECK
https://github.com/codecheckers/codecheck

codecheck r r-package reproducibility rstats

Last synced: 3 months ago
JSON representation

R package assistant for conducting a CODECHECK

• Host: GitHub
• URL: https://github.com/codecheckers/codecheck
• Owner: codecheckers
• License: mit
• Created: 2020-04-18T22:06:52.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-11-28T08:39:00.000Z (3 months ago)
• Last Synced: 2024-11-28T09:31:57.094Z (3 months ago)
• Topics: codecheck, r, r-package, reproducibility, rstats
• Language: R
• Homepage:
• Size: 366 KB
• Stars: 10
• Watchers: 3
• Forks: 3
• Open Issues: 36
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

• jimsghstars - codecheckers/codecheck - R package assistant for conducting a CODECHECK (R)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# codecheck

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)

[![R build status](https://github.com/codecheckers/codecheck/workflows/R-CMD-check/badge.svg)](https://github.com/codecheckers/codecheck/actions)

[![DOI](https://zenodo.org/badge/256862293.svg)](https://zenodo.org/badge/latestdoi/256862293)

`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](https://codecheck.org.uk/register/).

**Learn more about CODECHECK on [https://codecheck.org.uk/](https://codecheck.org.uk/).**

## Installation

The package is not on [CRAN](https://CRAN.R-project.org) yet.

Install the development version from [GitHub](https://github.com/codecheckers/codecheck) with:

``` r

# install.packages("remotes")

remotes::install_github("codecheckers/codecheck")

```

## Usage

See the main vignette.

## Development

The package uses [`tinytest`](https://cran.r-project.org/package=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 

```r

# 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`.