Merge pull request #12 from Spatiotemporal-Exposures-and-Toxicology/k…

…pm-pkgdown

starting pkgdown

.Rbuildignore

@@ -6,3 +6,6 @@
 ^\.github$
 ^script-replication$
 ^data-raw$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$

.github/.gitignore

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

.github/workflows/pkgdown.yaml

@@ -0,0 +1,48 @@
+# 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]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown, local::.
+          needs: website
+
+      - name: Build site
+        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/github-pages-deploy-action@v4.4.1
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

.gitignore

@@ -52,3 +52,4 @@ po/*~
 rsconnect/
 .Rproj.user
 inst/doc
+docs

DESCRIPTION

@@ -1,9 +1,11 @@
 Package: GeoToxPackage
 Title: What the Package Does (One Line, Title Case)
 Version: 0.0.0.9000
-Authors@R: 
-    person("First", "Last", , "first.last@example.com", role = c("aut", "cre"),
-           comment = c(ORCID = "YOUR-ORCID-ID"))
+Authors@R: c(
+    person("Skylar", "Marvel", , "skylar.marvel@nih.gov", role = c("aut", "ctb")),
+    person("David", "Reif", , "david.reif@nih.gov", role = c("aut", "ctb")),
+    person("Kyle", "Messier", , "kyle.messier@nih.gov", role = c("cre", "aut", "ctb"))
+  )
 Description: What the package does (one paragraph).
 License: MIT + file LICENSE
 Suggests: 
@@ -24,3 +26,4 @@ VignetteBuilder: knitr
 Depends: 
     R (>= 2.10)
 LazyData: true
+URL: https://spatiotemporal-exposures-and-toxicology.github.io/GeoToxPackage/

_pkgdown.yml

@@ -0,0 +1,4 @@
+url: https://spatiotemporal-exposures-and-toxicology.github.io/GeoToxPackage/
+template:
+  bootstrap: 5
+