Add GitHub Action for R CMD check. Update README.

Author: mccrea-cobb

.Rbuildignore

@@ -1,4 +1,5 @@
 ^.*\.Rproj$
 ^\.Rproj\.user$
 README.Rmd
-README.md
+README.md
+^\.github$

.github/.gitignore

@@ -0,0 +1 @@
+*.html

.github/workflows/R-CMD-check.yaml

@@ -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]
+  pull_request:
+    branches: [main]
+
+name: R-CMD-check.yaml
+
+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")'

README.Rmd

@@ -12,12 +12,14 @@ knitr::opts_chunk$set(
 )
 ```
 
-# akrreport <a href=""><img src="./README-images/logo.png" align="right" height="138" /></a>
-
 <!-- badges: start -->
 [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
+[![R-CMD-check](https://github.com/USFWS/akrreport/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/USFWS/akrreport/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
+akrreport <a href=""><img src="./README-images/logo.png" align="right" height="138" /></a>
+================================
+
 ## Overview
 
 This R package provides R Markdown and Quarto templates for reports generated by biologists at National Wildlife Refuges in Alaska, including the Alaska Refuge Report Series.
@@ -55,4 +57,10 @@ Contact the [project maintainer](emailto:[email protected]) for help with this
 
 ## Contribute
 
-Contact the [project maintainer](emailto:[email protected]) for information about contributing to this repository template. Submit a [GitHub Issue](https://github.com/USFWS/r7-repo-template/issues) to report a bug or request a feature or enhancement.
+Contact the [project maintainer](emailto:[email protected]) for information about contributing to this repository template. Submit a [GitHub Issue](https://github.com/USFWS/r7-repo-template/issues) to report a bug or request a feature or enhancement.
+
+-----
+
+![](https://i.creativecommons.org/l/by/4.0/88x31.png) This work is
+licensed under a [Creative Commons Attribution 1.0 International
+License](https://creativecommons.org/licenses/by/1.0/).

README.md

@@ -1,14 +1,14 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
-
-# akrreport <a href=""><img src="./README-images/logo.png" align="right" height="138" /></a>
-
 <!-- badges: start -->
 
 [![Lifecycle:
 experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
+[![R-CMD-check](https://github.com/USFWS/akrreport/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/USFWS/akrreport/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
+# akrreport <a href=""><img src="./README-images/logo.png" align="right" height="138" /></a>
+
 ## Overview
 
 This R package provides R Markdown and Quarto templates for reports
@@ -34,15 +34,21 @@ you’ll need:
 
 ## Usage
 
-The package reprository is currently set to Internal access. To install the template, 
-you will need to download the package as a tar.gz file [here](https://github.com/USFWS/akrreport/tags) 
-and then install from this file. 
+Install the template directly:
+
+``` r
+if (!requireNamespace("devtools")) install.packages("devtools")
+devtools::install_github("usfws/akrreport")
+```
 
 This will install the package `akrreport`. Once installed, templates
 will be available within the R Markdown and Quarto templates as shown
 below:
 
-![Alaska Refuge Report](./README-images/templates.png)
+<figure>
+<img src="./README-images/templates.png" alt="Alaska Refuge Report" />
+<figcaption aria-hidden="true">Alaska Refuge Report</figcaption>
+</figure>
 
 ## Getting help
 
@@ -55,3 +61,9 @@ Contact the [project maintainer](emailto:[email protected]) for
 information about contributing to this repository template. Submit a
 [GitHub Issue](https://github.com/USFWS/r7-repo-template/issues) to
 report a bug or request a feature or enhancement.
+
+------------------------------------------------------------------------
+
+![](https://i.creativecommons.org/l/by/4.0/88x31.png) This work is
+licensed under a [Creative Commons Attribution 1.0 International
+License](https://creativecommons.org/licenses/by/1.0/).