Skip to content

Latest commit

 

History

History
104 lines (74 loc) · 3.31 KB

README.md

File metadata and controls

104 lines (74 loc) · 3.31 KB

codecov CRAN Status License

ICES Logo

RDBEScore

RDBEScore provides functions to work with the Regional DataBase and Estimation System (RDBES).

It is implemented as an R package and available on GitHub

Installation

RDBEScore can be installed from GitHub using the install_github command from the remotes package:

library(remotes)

install_github("ices-tools-dev/RDBEScore", build_vignettes = TRUE)

Usage

For a summary of the package see the following Vignettes:

browseVignettes(package = "RDBEScore")

References

RDBEScore (Development)

RDBEScore is developed openly on GitHub.

Feel free to open an issue there if you encounter problems or have suggestions for future versions.

The current development version can be installed using:

library(remotes)
install_github("ices-tools-dev/RDBEScore@dev")

Precommit-hook framework

For adhering to package styling guides it is advisable to use precommit checks while developing. In order to run lintr and styler (etc) before committing code, follow the instructions at the following address: https://github.com/lorenzwalthert/precommit#installation

  1. Check that python3 is installed and install if necessary
  2. Run pip install
    pip3 install pre-commit --user
  3. Install R precommit package
    install.packages("precommit")
  4. Run at the root of the git repository.
    library(precommit)
    precommit::use_precommit()
  5. Running git commit should run the various checks automatically. See the config file for all the checks.