Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Workflow updates #107

Merged
merged 9 commits into from
Apr 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/workflows/check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ on:
- main
workflow_dispatch:

# Rerun workflows once pkgdown has finished running, to add coverage
# and unit test report to gh-pages branch.
workflow_run:
workflows: ["Docs 📚"]
types:
- completed

jobs:
audit:
name: Audit Dependencies 🕵️‍♂️
Expand All @@ -24,6 +31,15 @@ jobs:
uses: insightsengineering/r.pkg.template/.github/workflows/build-check-install.yaml@main
secrets:
REPO_GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }}
with:
enforce-note-blocklist: true
note-blocklist: |
checking dependencies in R code ... NOTE
checking R code for possible problems ... NOTE
checking examples ... NOTE
checking Rd line widths ... NOTE
unit-test-report-brand: >-
https://raw.githubusercontent.com/insightsengineering/hex-stickers/main/thumbs/rlistings.png
coverage:
name: Coverage 📔
uses: insightsengineering/r.pkg.template/.github/workflows/test-coverage.yaml@main
Expand Down
25 changes: 25 additions & 0 deletions .github/workflows/integration-tests.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Integration Tests 🧪

on:
schedule:
- cron: '45 3 * * 0'

jobs:
dependency-test:
strategy:
fail-fast: false
matrix:
test-strategy: ["min", "release", "max"]
uses: insightsengineering/r.pkg.template/.github/workflows/verdepcheck.yaml@main
name: Dependency Test - ${{ matrix.test-strategy }} 🔢
secrets:
REPO_GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }}
GCHAT_WEBHOOK: ${{ secrets.GCHAT_WEBHOOK }}
with:
strategy: ${{ matrix.test-strategy }}
cran-status:
name: CRAN Status Monitor 📺
uses: insightsengineering/r.pkg.template/.github/workflows/cran-status.yaml@main
with:
issue-assignees: "shajoezhu,Melkiades,edelarua,gmbecker,ayogasekaram"
21 changes: 21 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,24 @@ jobs:
uses: insightsengineering/r.pkg.template/.github/workflows/release.yaml@main
permissions:
contents: write
r-cmd:
name: R CMD Check 🧬
needs: [release, docs]
uses: insightsengineering/r.pkg.template/.github/workflows/build-check-install.yaml@main
secrets:
REPO_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
enforce-note-blocklist: true
note-blocklist: |
checking dependencies in R code ... NOTE
checking R code for possible problems ... NOTE
checking examples ... NOTE
checking Rd line widths ... NOTE
unit-test-report-brand: >-
https://raw.githubusercontent.com/insightsengineering/hex-stickers/main/thumbs/rlistings.png
coverage:
name: Coverage 📔
needs: [release, docs]
uses: insightsengineering/r.pkg.template/.github/workflows/test-coverage.yaml@main
secrets:
REPO_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

Check notice on line 2 in README.md

View workflow job for this annotation

GitHub Actions / grammar

README.md#L2

"is generated" may be passive voice

# rlistings <a href='https://github.com/insightsengineering/rlistings'><img src="man/figures/rlistings.png" align="right" alt="" width="180"></a>

<!-- start badges -->
[![Check
🛠](https://github.com/insightsengineering/rlistings/actions/workflows/check.yaml/badge.svg)](https://github.com/insightsengineering/rlistings/actions/workflows/check.yaml)
🛠](https://github.com/insightsengineering/rlistings/actions/workflows/check.yaml/badge.svg)](https://insightsengineering.github.io/rlistings/main/unit-test-report/)
[![Docs
📚](https://github.com/insightsengineering/rlistings/actions/workflows/docs.yaml/badge.svg)](https://insightsengineering.github.io/rlistings/)
[![Code Coverage
📔](https://raw.githubusercontent.com/insightsengineering/rlistings/_xml_coverage_reports/data/main/badge.svg)](https://raw.githubusercontent.com/insightsengineering/rlistings/_xml_coverage_reports/data/main/coverage.xml)
📔](https://raw.githubusercontent.com/insightsengineering/rlistings/_xml_coverage_reports/data/main/badge.svg)](https://insightsengineering.github.io/rlistings/main/coverage-report/)

![GitHub
forks](https://img.shields.io/github/forks/insightsengineering/rlistings?style=social)
Expand Down Expand Up @@ -39,31 +39,31 @@

## Listings with R

The `rlistings` R package is a package that was designed to create and

Check notice on line 42 in README.md

View workflow job for this annotation

GitHub Actions / grammar

README.md#L42

"was designed" may be passive voice
display listings with R. The focus of this package is to provide
functionality for value formatting and ASCII rendering infrastructure
for tables and listings. Many of the functions contained in `rlistings`

Check notice on line 45 in README.md

View workflow job for this annotation

GitHub Actions / grammar

README.md#L45

"Many" is a weasel word and can weaken meaning
depend on the
[`formatters`](https://insightsengineering.github.io/formatters/)
package, which provides a framework for ASCII rendering and is available
on CRAN.

`rlistings` development is driven by the need to create regulatory ready

Check notice on line 51 in README.md

View workflow job for this annotation

GitHub Actions / grammar

README.md#L51

"is driven" may be passive voice
listings for health authority review. Some of the key requirements for
this undertaking are listed below:

Check notice on line 53 in README.md

View workflow job for this annotation

GitHub Actions / grammar

README.md#L53

"are listed" may be passive voice

- flexible formatting (pagesize, column widths, alignment, labels, etc.)
- multiple output formats (csv, out, txt)

Check notice on line 56 in README.md

View workflow job for this annotation

GitHub Actions / grammar

README.md#L56

"multiple" is wordy or unneeded
- repeated key columns
- flexible pagination in both horizontal and vertical directions
- titles and footnotes

`rlistings` currently covers some of these requirements, and remains

Check notice on line 61 in README.md

View workflow job for this annotation

GitHub Actions / grammar

README.md#L61

"currently" can weaken meaning
under active development.

## Installation

For releases from October 2022 it is recommended that you [create and

Check notice on line 66 in README.md

View workflow job for this annotation

GitHub Actions / grammar

README.md#L66

"it is" is wordy or unneeded

Check notice on line 66 in README.md

View workflow job for this annotation

GitHub Actions / grammar

README.md#L66

"is recommended" may be passive voice
use a Github
PAT](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token)
to install the latest version of this package. Once you have the PAT,
Expand All @@ -90,9 +90,9 @@

``` r
library(rlistings)
#> Warning: package 'rlistings' was built under R version 4.2.2

Check notice on line 93 in README.md

View workflow job for this annotation

GitHub Actions / grammar

README.md#L93

"was built" may be passive voice
#> Loading required package: formatters
#> Warning: package 'formatters' was built under R version 4.2.2

Check notice on line 95 in README.md

View workflow job for this annotation

GitHub Actions / grammar

README.md#L95

"was built" may be passive voice
#> Loading required package: tibble

# Reducing the data
Expand All @@ -103,19 +103,19 @@
cols = c("gear", "carb", "qsec", "car")
) %>% head()
#> sorting incoming data by key columns
#> gear carb qsec car
#> gear carb qsec car
#> ———————————————————————————————————————
#> 3 1 19.44 Hornet 4 Drive
#> 20.22 Valiant
#> 20.01 Toyota Corona
#> 3 1 19.44 Hornet 4 Drive
#> 20.22 Valiant
#> 20.01 Toyota Corona
#> 2 17.02 Hornet Sportabout
#> 16.87 Dodge Challenger
#> 16.87 Dodge Challenger
#> 17.3 AMC Javelin
```

## Acknowledgment

This package is a result of a joint effort by many developers and

Check notice on line 118 in README.md

View workflow job for this annotation

GitHub Actions / grammar

README.md#L118

"many" is a weasel word and can weaken meaning
stakeholders. We would like to thank everyone who contributed so far!

## Stargazers and Forkers
Expand Down
15 changes: 13 additions & 2 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@ template:
package: nesttemplate

navbar:
right:
- icon: fa-github
structure:
left: [intro, reference, articles, tutorials, news, reports]
right: [search, github]
components:
reports:
text: Reports
menu:
- text: Coverage report
href: coverage-report/
- text: Unit test report
href: unit-test-report/
github:
icon: fa-github
href: https://github.com/insightsengineering/rlistings
Loading