Data

Tools

Indexes

Applications

Experiments

Open Source Science

codecheck

R package assistant for conducting a CODECHECK

https://github.com/codecheckers/codecheck

Science Score: 54.0%

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

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.1%) to scientific vocabulary

Keywords

codecheck r r-package reproducibility rstats
Last synced: 6 months ago · JSON representation ·

Repository

R package assistant for conducting a CODECHECK

Basic Info
  • Host: GitHub
  • Owner: codecheckers
  • License: mit
  • Language: R
  • Default Branch: master
  • Homepage:
  • Size: 400 KB
Statistics
  • Stars: 11
  • Watchers: 2
  • Forks: 4
  • Open Issues: 40
  • Releases: 1
Topics
codecheck r r-package reproducibility rstats
Created almost 6 years ago · Last pushed 8 months ago
Metadata Files
Readme Changelog License Citation Zenodo

README.Rmd 

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

Owner

  • Name: CODECHECK
  • Login: codecheckers
  • Kind: organization

Citation (CITATION.cff) 

cff-version: 1.1.0
message: If you use this software, please cite it as below.
authors:
  - family-names: Eglen
    given-names: Stephen
    orcid: https://orcid.org/0000-0001-8607-8025
  - family-names: Nüst
    given-names: Daniel
    orcid: https://orcid.org/0000-0002-0024-5046
title: "codecheck R package: Helper Functions for CODECHECK Project"
version: 0.1.0
#doi: 10.5281/zenodo.TODO
date-released: 2020-02-09
license: MIT
repository-code: https://github.com/codecheckers/codecheck

GitHub Events

Total
  • Issues event: 6
  • Watch event: 1
  • Delete event: 1
  • Issue comment event: 6
  • Push event: 22
  • Pull request event: 11
  • Fork event: 1
  • Create event: 7
Last Year
  • Issues event: 6
  • Watch event: 1
  • Delete event: 1
  • Issue comment event: 6
  • Push event: 22
  • Pull request event: 11
  • Fork event: 1
  • Create event: 7

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 4
  • Total pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 hour
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.67
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 4
  • Pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 hour
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.67
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • nuest (7)
  • sje30 (1)
  • langtonhugh (1)
Pull Request Authors
  • angelina-momin (26)
  • langtonhugh (3)
  • nuest (2)
Top Labels
Issue Labels
enhancement (3) good first issue (2) bug (1) help wanted (1) documentation (1)
Pull Request Labels

Dependencies

DESCRIPTION cran
  • R >= 4.0.0 depends
  • R.cache * depends
  • gh * depends
  • parsedate * depends
  • assertthat * imports
  • httr * imports
  • jsonlite * imports
  • knitr * imports
  • osfr * imports
  • rmarkdown * imports
  • rorcid * imports
  • stringr * imports
  • xtable * imports
  • yaml * imports
  • skimr * suggests
  • tinytest * suggests
  • ttdo * suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/cache v1 composite
  • actions/checkout v2 composite
  • actions/upload-artifact main composite
  • r-lib/actions/setup-pandoc master composite
  • r-lib/actions/setup-r master composite