diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml new file mode 100644 index 0000000..310c25b --- /dev/null +++ b/.github/workflows/R-CMD-check.yaml @@ -0,0 +1,50 @@ +# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples +# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help + +on: + push: + branches: [main, master] + pull_request: + branches: [main, master] + +name: R CMD Check + +jobs: + R-CMD-check: + runs-on: ${{ matrix.config.os }} + + name: ${{ matrix.config.os }} (${{ matrix.config.r }}) + + strategy: + fail-fast: false + matrix: + config: + - {os: macos-latest, r: 'release'} + - {os: windows-latest, r: 'release'} + - {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'} + - {os: ubuntu-latest, r: 'release'} + - {os: ubuntu-latest, r: 'oldrel-1'} + + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + R_KEEP_PKG_SOURCE: yes + + steps: + - uses: actions/checkout@v3 + + - uses: r-lib/actions/setup-pandoc@v2 + + - uses: r-lib/actions/setup-r@v2 + with: + r-version: ${{ matrix.config.r }} + http-user-agent: ${{ matrix.config.http-user-agent }} + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::rcmdcheck + needs: check + + - uses: r-lib/actions/check-r-package@v2 + with: + upload-snapshots: true diff --git a/README.Rmd b/README.Rmd index ee7513f..9b602df 100644 --- a/README.Rmd +++ b/README.Rmd @@ -16,6 +16,8 @@ knitr::opts_chunk$set( ![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg) +[![codecov](https://codecov.io/gh/davidcrone/xafty/branch/main/graph/badge.svg)](https://codecov.io/gh/davidcrone/xafty) +[![R CMD Check](https://github.com/davidcrone/xafty/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/davidcrone/xafty/actions/workflows/R-CMD-check.yaml) The package is designed to help with creating automation for diff --git a/README.md b/README.md index 2dc7dd5..97ac41f 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,20 @@ ![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg) +[![codecov](https://codecov.io/gh/davidcrone/xafty/branch/main/graph/badge.svg)](https://codecov.io/gh/davidcrone/xafty) +[![R CMD +Check](https://github.com/davidcrone/xafty/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/davidcrone/xafty/actions/workflows/R-CMD-check.yaml) -The package is designed to facilitate task automation for tasks that are -often completed in Excel. After reading in data from Excel, values and -columns usually do not align with the assumptions of the code. The xafty -package offers a lightweight solution to check whether the Excel data -adheres to the specified rules stored in a validation table (referred to -as “validity table”). The package aims to achieve the following goals: +The package is designed to help with creating automation for tasks that +are based on a Spreadsheet document (like Excel). After reading in data +from a spreadsheet, values and columns usually do not align with the +assumptions of the code if the document is edited by hand. + +Xafty offers a lightweight solution to check whether the spreadsheet +data adheres to the specified rules stored in a validation table +(referred to as “validity table”). The package aims to achieve the +following goals: 1. Facilitate communication between the developer and user by agreeing on rules detailing how the data should be structured.