Skip to content

Commit

Permalink
Add CMD BUILD check
Browse files Browse the repository at this point in the history
  • Loading branch information
margauxgo committed Jun 20, 2024
1 parent a47461c commit 9bc78e3
Show file tree
Hide file tree
Showing 5 changed files with 60 additions and 8 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@
^docs$
^pkgdown$
^references.bib$
^\.github$
1 change: 1 addition & 0 deletions .github/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.html
52 changes: 52 additions & 0 deletions .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# 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

permissions: read-all

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@v4

- 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
build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ knitr::opts_chunk$set(

[![License: CC BY
4.0](https://img.shields.io/badge/License-CC_BY_4.0-lightblue.svg)](https://creativecommons.org/licenses/by/4.0/)

[![R-CMD-check](https://github.com/openwashdata/ugabore/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/openwashdata/ugabore/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

The goal of `ugabore` is to provide users with documentation on borehole repair data collected from two districts in central Uganda where a borehole operation and maintenance program is run. The dataset is associated with the following [project report](https://ds4owd-001.github.io/project-ljc3084/) completed by Joseph Lwere for the ["data science for openwashdata" course](https://ds4owd-001.github.io/website/) offered by [openwashdata.org](https://openwashdata.org/).
Expand Down
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

[![License: CC BY
4.0](https://img.shields.io/badge/License-CC_BY_4.0-lightblue.svg)](https://creativecommons.org/licenses/by/4.0/)

[![R-CMD-check](https://github.com/openwashdata/ugabore/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/openwashdata/ugabore/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

The goal of `ugabore` is to provide users with documentation on borehole
Expand Down Expand Up @@ -62,7 +62,7 @@ library(ugabore)
The `ugabore` data set has 10 variables and 171 observations. For an
overview of the variable names, see the following table.

<table class="table table-striped" style="color: black; margin-left: auto; margin-right: auto;">
<table class="table table-striped" style="margin-left: auto; margin-right: auto;">
<thead>
<tr>
<th style="text-align:left;">
Expand Down Expand Up @@ -263,8 +263,7 @@ citation("ugabore")
#> To cite package 'ugabore' in publications use:
#>
#> Götschmann M, Lwere J (2024). _ugabore: Borehole repair data from
#> central Uganda_. R package version 0.0.0.9000, commit
#> bb70c351dc0cc44b46bf54bdc11c8c4c034a1a17,
#> central Uganda_. R package version 0.0.0.9000,
#> <https://github.com/openwashdata/ugabore>.
#>
#> A BibTeX entry for LaTeX users is
Expand All @@ -273,13 +272,12 @@ citation("ugabore")
#> title = {ugabore: Borehole repair data from central Uganda},
#> author = {Margaux Götschmann and Joseph Lwere},
#> year = {2024},
#> note = {R package version 0.0.0.9000, commit bb70c351dc0cc44b46bf54bdc11c8c4c034a1a17},
#> note = {R package version 0.0.0.9000},
#> url = {https://github.com/openwashdata/ugabore},
#> }
```

<div id="refs" class="references csl-bib-body hanging-indent"
entry-spacing="0">
<div id="refs" class="references csl-bib-body hanging-indent">

<div id="ref-lapworth2020drinking" class="csl-entry">

Expand Down

0 comments on commit 9bc78e3

Please sign in to comment.