Skip to content

Commit

Permalink
Added Badges to README
Browse files Browse the repository at this point in the history
  • Loading branch information
The Rational Optimist committed Oct 7, 2023
1 parent e93b0db commit a6a9dab
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 6 deletions.
50 changes: 50 additions & 0 deletions .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ knitr::opts_chunk$set(

<!-- badges: start -->
![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)
<!-- badges: end -->

The package is designed to help with creating automation for
Expand Down
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,20 @@
<!-- badges: start -->

![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)
<!-- badges: end -->

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.
Expand Down

0 comments on commit a6a9dab

Please sign in to comment.