Skip to content

This repository is intended to apply a set of GitHub Actions on a simple Rcpp package

License

Notifications You must be signed in to change notification settings

Shehab7osny/calculatorRcpp

Repository files navigation

Build Status License: MIT

calculatorRcpp

A simple R package (calculator) implementing a workflow for GitHub Actions using r-lib/actions.

Build and Installation

Linux

Rscript -e 'devtools::install_github("shehab7osny/calculatorrcpp")'

Windows

Rscript.exe -e 'devtools::install_github("shehab7osny/calculatorrcpp")'

GitHub Actions Workflow

This repository's workflow carries out the following jobs:

  • Checks for a successful build on Linux.
    Using:
    • r-lib/actions/setup
    • r-lib/actions/setup-r-dependencies
  • Checks for a successful build on Windows.
    Using:
    • r-lib/actions/setup
    • r-lib/actions/setup-r-dependencies
  • Checks for a errors in the R package.
    Using:
    • r-lib/actions/check-r-package
  • Checks for any memory leakages in the R package.
    Using:
    • r-lib/actions/run-rchk
      Limitations: Due to an issue in r-lib/actions, this check is only done during setup.

Examples

Seceral examples can be located in the demo directory. These examples are as follows:

  • AddExample
    Illustrates the addition functionality of the calculator.
    R -e 'demo("AddExample", "calculatorRcpp")'
  • SubtractExample
    Illustrates the subtraction functionality of the calculator.
    R -e 'demo("SubtractExample", "calculatorRcpp")'
  • MultiplyExample
    Illustrates the multiplication functionality of the calculator.
    R -e 'demo("MultiplyExample", "calculatorRcpp")'
  • DivideExample
    Illustrates the division functionality of the calculator.
    R -e 'demo("DivideExample", "calculatorRcpp")'

About

This repository is intended to apply a set of GitHub Actions on a simple Rcpp package

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published