Skip to content

JavaScript library and CLI tool for ERC validation and comparison result checking

License

Notifications You must be signed in to change notification settings

o2r-project/erc-checker

Repository files navigation

erc-checker

Build Status Build status npm Project Status: Active – The project has reached a stable, usable state and is being actively developed. DOI SWH

A JavaScript library and CLI tool for ERC result checking.

The checker is part of the project Opening Reproducible Research (o2r). Its purpose is to verify the result of reproductions of scientific papers as part of the o2r reproducibility service by means of comparing the HTML of the original and reproduced article.

The checker runs on NodeJS. The tool implements a NodeJS module, which is a function returning a JavaScript Promise. It further implements a command line interface (WORK IN PROGRESS).

The documentation is available at https://o2r.info/erc-checker/.

Contribute

All help is welcome: asking questions, providing documentation, testing, or even development. See CONTRIBUTING.md for details.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Publish a new release

# see npm version --help
npm version {major,minor,bugfix}
npm publish

Add version tag locally, e.g., v.1.2.3, and push to remotes. Then create a new release on GitHub.

How to cite

To cite this software please use

Nüst, Daniel, 2018. Reproducibility Service for Executable Research Compendia: Technical Specifications and Reference Implementation. Zenodo. doi:10.5281/zenodo.2203843

License

o2r checker is licensed under Apache License, Version 2.0, see file LICENSE.

Copyright (C) 2020 - o2r project.

o2r