Feature/website

.Rbuildignore

@@ -6,3 +6,6 @@
 ^LICENSE\.md$
 ^\.github$
 ^\.lintr$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$

.github/workflows/pkgdown.yaml

@@ -0,0 +1,49 @@
+# 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:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown.yaml
+
+permissions: read-all
+
+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@v4
+
+      - 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.5.0
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

.gitignore

@@ -1 +1,2 @@
 .Rproj.user
+docs

DESCRIPTION

@@ -15,7 +15,7 @@ Description: Elicitr is an R package, used to aggregate elicitation data. The
     formal elicitation methods. You provide the data, and elicitr transforms
     them into easily readable graphics.
 License: GPL (>= 3)
-URL: https://github.com/orgs/CREWdecisions/elicitr
+URL: https://crewdecisions.github.io/elicitr/
 BugReports: https://github.com/CREWdecisions/elicitr/issues
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)

README.Rmd

@@ -23,12 +23,12 @@ knitr::opts_chunk$set(
 
 ### Description
 
-elicitr is an R package, used to aggregate elicitation data.\
+elicitr is an R package used to standardise, visualise and aggregate data from expert elicitation.\
 The package is in active development and will implement functions based on two formal elicitation methods:
 
-* Continuous method\
-  Adapted from Hemming, V. et al. (2018) A practical guide to structured expert elicitation using the IDEA protocol. Methods in Ecology and Evolution, 9(1), 169–180. https://doi.org/10.1111/2041-210X.12857
-* Categorical method\
+* Elicitation of continuous variables\
+  Adapted from Hemming, V. et al. (2018). A practical guide to structured expert elicitation using the IDEA protocol. Methods in Ecology and Evolution, 9(1), 169–180. https://doi.org/10.1111/2041-210X.12857
+* Elicitation of categorical data\
   Adapted from Vernet, M. et al. (2024). Assessing invasion risks using EICAT-based expert elicitation: application to a conservation translocation. Biological Invasions, 26(8), 2707–2721. https://doi.org/10.1007/s10530-024-03341-2
 
 ### Installation
@@ -40,7 +40,7 @@ You can install the development version of elicitr from GitHub with:
 pak::pak("CREWdecisions/elicitr")
 ```
 
-### Related work
+### Similar packages
 
 * {shelf} : Oakley, J. (2024). Package “SHELF” Tools to Support the Sheffield Elicitation Framework. https://doi.org/10.32614/CRAN.package.SHELF
 * {prefR} : Lepird, J. (2022). Package “prefeR” R Package for Pairwise Preference Elicitation. https://doi.org/10.32614/CRAN.package.prefeR

README.md

@@ -15,14 +15,16 @@ coverage](https://codecov.io/gh/CREWdecisions/elicitr/graph/badge.svg)](https://
 
 ### Description
 
-elicitr is an R package used to standardize, visualize and aggregate data from expert elicitation.  
+elicitr is an R package used to standardise, visualise and aggregate
+data from expert elicitation.  
 The package is in active development and will implement functions based
 on two formal elicitation methods:
 
 - Elicitation of continuous variables  
-  Adapted from Hemming, V. et al. (2018). A practical guide to structured
-  expert elicitation using the IDEA protocol. Methods in Ecology and
-  Evolution, 9(1), 169–180. <https://doi.org/10.1111/2041-210X.12857>
+  Adapted from Hemming, V. et al. (2018). A practical guide to
+  structured expert elicitation using the IDEA protocol. Methods in
+  Ecology and Evolution, 9(1), 169–180.
+  <https://doi.org/10.1111/2041-210X.12857>
 - Elicitation of categorical data  
   Adapted from Vernet, M. et al. (2024). Assessing invasion risks using
   EICAT-based expert elicitation: application to a conservation

pkgdown/_pkgdown.yml

@@ -0,0 +1,22 @@
+url: https://crewdecisions.github.io/elicitr/
+template:
+  bootstrap: 5
+  math-rendering: mathjax
+  light-switch: true
+
+reference:
+- title: "Elicitation of continuous variables"
+  desc: >
+    Functions for handling and plotting continuous variables.
+  contents:
+  - elic_start
+  - elic_add_data
+  - elic_get_data
+  - elic_plot
+
+- title: "Simulated data"
+  desc: >
+    Datasets of simulated data used for demonstration.
+  contents:
+  - round_1
+  - round_2

pkgdown/favicon/site.webmanifest

@@ -0,0 +1,21 @@
+{
+  "name": "",
+  "short_name": "",
+  "icons": [
+    {
+      "src": "/web-app-manifest-192x192.png",
+      "sizes": "192x192",
+      "type": "image/png",
+      "purpose": "maskable"
+    },
+    {
+      "src": "/web-app-manifest-512x512.png",
+      "sizes": "512x512",
+      "type": "image/png",
+      "purpose": "maskable"
+    }
+  ],
+  "theme_color": "#ffffff",
+  "background_color": "#ffffff",
+  "display": "standalone"
+}