Skip to content

Commit

Permalink
README and workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
aphalo committed Feb 2, 2024
1 parent 5a040dc commit e17c179
Show file tree
Hide file tree
Showing 7 changed files with 31 additions and 67 deletions.
75 changes: 20 additions & 55 deletions .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
# For help debugging build failures open an issue on the RStudio community with the 'github-actions' tag.
# https://community.rstudio.com/new-topic?category=Package%20development&tags=github-actions
# 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
branches: [main, master]
pull_request:
branches:
- main
- master
branches: [main, master]

name: R-CMD-check

Expand All @@ -22,63 +18,32 @@ jobs:
fail-fast: false
matrix:
config:
- {os: macos-latest, r: 'release'}
- {os: windows-latest, r: 'release'}
- {os: macOS-latest, r: 'release'}
- {os: ubuntu-20.04, r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}
- {os: ubuntu-20.04, r: 'devel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
- {os: ubuntu-latest, r: 'release'}
- {os: ubuntu-latest, r: 'oldrel-1'}

env:
R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
RSPM: ${{ matrix.config.rspm }}
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
R_KEEP_PKG_SOURCE: yes

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3

- uses: r-lib/actions/setup-r@v1
- 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-pandoc@v1

- name: Query dependencies
run: |
install.packages('remotes')
saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
shell: Rscript {0}

- name: Cache R packages
if: runner.os != 'Windows'
uses: actions/cache@v2
- uses: r-lib/actions/setup-r-dependencies@v2
with:
path: ${{ env.R_LIBS_USER }}
key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-

- name: Install system dependencies
if: runner.os == 'Linux'
run: |
while read -r cmd
do
eval sudo $cmd
done < <(Rscript -e 'writeLines(remotes::system_requirements("ubuntu", "20.04"))')
- name: Install dependencies
run: |
remotes::install_deps(dependencies = TRUE)
remotes::install_cran("rcmdcheck")
shell: Rscript {0}

- name: Check
env:
_R_CHECK_CRAN_INCOMING_REMOTE_: false
run: rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran"), error_on = "warning", check_dir = "check")
shell: Rscript {0}
extra-packages: any::rcmdcheck
needs: check

- name: Upload check results
if: failure()
uses: actions/upload-artifact@main
- uses: r-lib/actions/check-r-package@v2
with:
name: ${{ runner.os }}-r${{ matrix.config.r }}-results
path: check
upload-snapshots: true
6 changes: 3 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
output: github_document
output:
github_document:
html_preview: TRUE
---

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

```{r readme-01, echo = FALSE}
knitr::opts_chunk$set(
fig.asp = 2/3,
Expand Down
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

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

# gginnards <img src="man/figures/logo-gginnards.png" align="right" width="150" />

[![cran
Expand Down Expand Up @@ -128,9 +126,9 @@ ggplot(mtcars, aes(cyl, mpg, colour = factor(cyl))) +

#> [1] "Summary of input 'data' to 'draw_panel()':"
#> colour x group y ymin ymax PANEL flipped_aes
#> 1 #F8766D 4 1 26.66364 24.26341 29.21955 1 FALSE
#> 2 #00BA38 6 2 19.74286 18.68536 20.67143 1 FALSE
#> 3 #619CFF 8 3 15.10000 13.74268 16.24304 1 FALSE
#> 1 #F8766D 4 1 26.66364 24.30000 28.93727 1 FALSE
#> 2 #00BA38 6 2 19.74286 18.75679 20.72893 1 FALSE
#> 3 #619CFF 8 3 15.10000 13.84268 16.32875 1 FALSE

We print to the R console `data` as *seen* as input by statistics that
use a *panel function*.
Expand Down Expand Up @@ -218,16 +216,17 @@ citation("gginnards")
#> To cite package 'gginnards' in publications use:
#>
#> Aphalo P (2023). _gginnards: Explore the Innards of 'ggplot2'
#> Objects_. https://www.r4photobiology.info,
#> https://github.com/aphalo/gginnards.
#> Objects_. R package version 0.1.2,
#> <https://CRAN.R-project.org/package=gginnards>.
#>
#> A BibTeX entry for LaTeX users is
#>
#> @Manual{,
#> title = {gginnards: Explore the Innards of 'ggplot2' Objects},
#> author = {Pedro J. Aphalo},
#> year = {2023},
#> note = {https://www.r4photobiology.info, https://github.com/aphalo/gginnards},
#> note = {R package version 0.1.2},
#> url = {https://CRAN.R-project.org/package=gginnards},
#> }
```

Expand Down
2 changes: 1 addition & 1 deletion _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
destination: ../gginnards-docs
destination: ../docs/gginnards
url: https://docs.r4photobiology.info/gginnards/

template:
Expand Down
Binary file modified man/figures/README-unnamed-chunk-4-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-unnamed-chunk-6-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-unnamed-chunk-6-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e17c179

Please sign in to comment.