Skip to content

Commit 4d00957

Browse files
committed
set up pkgdown config
1 parent 4702208 commit 4d00957

File tree

7 files changed

+86
-0
lines changed

7 files changed

+86
-0
lines changed

.Rbuildignore

+4
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,7 @@
33
^data-raw$
44
^README\.Rmd$
55
^LICENSE\.md$
6+
^\.github$
7+
^_pkgdown\.yml$
8+
^docs$
9+
^pkgdown$

.github/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.html

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

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2+
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
3+
on:
4+
push:
5+
branches: [main, master]
6+
pull_request:
7+
branches: [main, master]
8+
9+
name: R-CMD-check
10+
11+
jobs:
12+
R-CMD-check:
13+
runs-on: ${{ matrix.config.os }}
14+
15+
name: ${{ matrix.config.os }} (${{ matrix.config.r }})
16+
17+
strategy:
18+
fail-fast: false
19+
matrix:
20+
config:
21+
- {os: macos-latest, r: 'release'}
22+
- {os: windows-latest, r: 'release'}
23+
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
24+
- {os: ubuntu-latest, r: 'release'}
25+
- {os: ubuntu-latest, r: 'oldrel-1'}
26+
27+
env:
28+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
29+
R_KEEP_PKG_SOURCE: yes
30+
31+
steps:
32+
- uses: actions/checkout@v3
33+
34+
- uses: r-lib/actions/setup-pandoc@v2
35+
36+
- uses: r-lib/actions/setup-r@v2
37+
with:
38+
r-version: ${{ matrix.config.r }}
39+
http-user-agent: ${{ matrix.config.http-user-agent }}
40+
use-public-rspm: true
41+
42+
- uses: r-lib/actions/setup-r-dependencies@v2
43+
with:
44+
extra-packages: any::rcmdcheck
45+
needs: check
46+
47+
- uses: r-lib/actions/check-r-package@v2
48+
with:
49+
upload-snapshots: true

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@
44
.httr-oauth
55
.DS_Store
66
.quarto
7+
docs

README.Rmd

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ library(universityrankingafrica)
2626
# basisghana
2727

2828
<!-- badges: start -->
29+
[![R-CMD-check](https://github.com/openwashdata/basisghana/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/openwashdata/basisghana/actions/workflows/R-CMD-check.yaml)
2930
<!-- badges: end -->
3031

3132
This package compiles sanitation data from established Open Defecation Free (ODF) communities across different regions in Ghana.

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
# basisghana
55

66
<!-- badges: start -->
7+
8+
[![R-CMD-check](https://github.com/openwashdata/basisghana/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/openwashdata/basisghana/actions/workflows/R-CMD-check.yaml)
79
<!-- badges: end -->
810

911
This package compiles sanitation data from established Open Defecation

_pkgdown.yml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
url: https://github.com/openwashdata/basisghana/blob/main/_pkgdown.yml
2+
3+
template:
4+
bootstrap: 5
5+
includes:
6+
in_header: |
7+
<script defer data-domain="openwashdata.github.io/" src="https://plausible.io/js/script.js"></script>
8+
9+
home:
10+
links:
11+
- icon: github
12+
text: GitHub repository
13+
href: https://github.com/openwashdata/basisghana
14+
sidebar:
15+
structure: [links, citation, authors, dev, custom]
16+
components:
17+
custom:
18+
title:
19+
text:
20+
21+
authors:
22+
footer:
23+
roles: [cre, fnd]
24+
text: "Crafted by"
25+
sidebar:
26+
roles: [cre, aut, ctb]
27+
before: "So *who* does the work?"
28+
after: "Thanks all!"

0 commit comments

Comments
 (0)