Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/bisaloo/signaturechecker

Statically check the signature of base R functions in your code

https://github.com/bisaloo/signaturechecker

Science Score: 26.0%

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

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.3%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

Statically check the signature of base R functions in your code

Basic Info
  • Host: GitHub
  • Owner: Bisaloo
  • License: other
  • Language: R
  • Default Branch: main
  • Size: 1.53 MB
Statistics
  • Stars: 1
  • Watchers: 0
  • Forks: 0
  • Open Issues: 7
  • Releases: 0
Created 11 months ago · Last pushed 10 months ago
Metadata Files
Changelog License

https://github.com/Bisaloo/signaturechecker/blob/main/ 



# signaturechecker





The goal of signaturechecker is to use static analysis (via the [lintr R
package](https://lintr.r-lib.org/)) to check if base R functions in a
given codebase are used with the correct signature.

## Motivation

This package provides a way to check, without any modification to the
source package or its own check infrastructure, for:

- Partially matched arguments
- Invalid arguments:
  - For functions that dont use ellipses, invalid arguments will
    generate an error upon execution. But it can still go undetected
    while developing R package if code coverage is low and this section
    of the code is untested.
  - For functions that use ellipses, invalid arguments can be ignored
    silently if the function doesnt use `chkDots(...)` or something
    equivalent, even in the case of complete code coverage.

## Installation

You can install the development version of signaturechecker from
[GitHub](https://github.com/) with:

``` r
# install.packages("pak")
pak::pak("Bisaloo/signaturechecker")
```

## Usage

This package is still experimental and it is not recommended to put it
in your `.lintr` configuration file at this stage.

You can however periodically check the signature of the base functions
in your codebase by running:

``` r
lintr::lint_package(
  linters=lintr::all_linters(packages="signaturechecker")
)
```

Owner

  • Name: Hugo Gruson
  • Login: Bisaloo
  • Kind: user
  • Location: Heidelberg
  • Company: EMBL

Evolutionary Biologist turned Research Software Engineer in R.

GitHub Events

Total
  • Issues event: 5
  • Push event: 2
  • Create event: 2
Last Year
  • Issues event: 5
  • Push event: 2
  • Create event: 2

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/dependency-change.yaml actions
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/lint-changed-files.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.7.3 composite
  • actions/checkout v4 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
  • untitaker/hyperlink 0.1.44 composite
.github/workflows/pull-from-packagetemplate.yaml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/upload-artifact v4 composite
  • peter-evans/create-pull-request v7 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • codecov/codecov-action v5 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/update-citation-cff.yaml actions
  • actions/checkout v4 composite
  • peter-evans/create-pull-request v7 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION cran
  • R >= 4.0.0 depends
  • knitr * suggests
  • rmarkdown * suggests
  • spelling * suggests
  • testthat >= 3.0.0 suggests