From 24884632634be34f931881a571418a3fcb4424e1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tomasz=20Wo=C5=BAniak?= <wozniak.tom@pm.me>
Date: Thu, 18 Jul 2024 12:59:35 +1000
Subject: [PATCH] create pkgdown website and deployment #12

---
 .Rbuildignore                  |  3 ++
 .github/workflows/pkgdown.yaml | 50 ++++++++++++++++++++++
 .gitignore                     |  1 +
 _pkgdown.yml                   | 78 ++++++++++++++++++++++++++++++++++
 4 files changed, 132 insertions(+)
 create mode 100644 .github/workflows/pkgdown.yaml
 create mode 100644 _pkgdown.yml

diff --git a/.Rbuildignore b/.Rbuildignore
index 3a82aad..0a5ed1f 100644
--- a/.Rbuildignore
+++ b/.Rbuildignore
@@ -4,3 +4,6 @@
 ^bsvarSIGNs\.Rproj$
 ^\.Rproj\.user$
 ^/inst/varia$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
new file mode 100644
index 0000000..c9f0165
--- /dev/null
+++ b/.github/workflows/pkgdown.yaml
@@ -0,0 +1,50 @@
+# 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
+
+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
diff --git a/.gitignore b/.gitignore
index 2b050fe..1d87a65 100644
--- a/.gitignore
+++ b/.gitignore
@@ -56,3 +56,4 @@ rsconnect/
 .DS_Store
 .quarto
 *.so
+docs
diff --git a/_pkgdown.yml b/_pkgdown.yml
new file mode 100644
index 0000000..12aaf62
--- /dev/null
+++ b/_pkgdown.yml
@@ -0,0 +1,78 @@
+url: https://bsvars.github.io/bsvarSIGNs/
+template:
+  bootstrap: 5
+development:
+  mode: auto
+navbar:
+  structure:
+    right:
+    - github
+    - twitter
+    - instagram
+    - mastodon
+    - bluesky
+    - email
+  components:
+    github:
+      icon: github
+      href: https://github.com/bsvars
+      aria-label: github
+    twitter:
+      icon: twitter
+      href: https://x.com/bsvars
+      aria-label: twitter
+    instagram:
+      icon: instagram
+      href: https://www.instagram.com/bsvarsoninsta/
+      aria-label: instagram
+    mastodon:
+      icon: bi-mastodon
+      href: https://fosstodon.org/@bsvars
+      aria-label: mastodon
+    bluesky:
+      icon: cloud
+      href: https://bsky.app/profile/bsvars.bsky.social
+      aria-label: bluesky
+    email:
+      icon: envelope
+      href: mailto:bsvars@pm.me
+reference:
+- title: 'bsvarSIGNs: Bayesian Estimation of Structural Vector Autoregressions Identified
+    by Sign, Zero, and Narrative Restrictions'
+  desc: Browse package information
+- contents:
+  - bsvarSIGNs-package
+  - bsvarSIGNs
+- title: Data
+  desc: Upload sample data set
+- contents:
+  - optimism
+  - monetary
+- title: Model specification
+  desc: Choose a model to work with
+- contents: matches("specify_")
+- title: More detailed model specification
+  desc: Adjust or inspect the specified model
+- contents:
+  - matches("specify_data")
+  - matches("specify_iden")
+  - matches("specify_prior")
+  - matches("specify_start")
+- title: Estimation
+  desc: Run Bayesian estimation of your model and inspect the outputs
+- contents:
+  - matches("estimate")
+  - matches("specify_posterior")
+- title: Posterior summaries
+  desc: Analyse the posterior summaries of the posterior estimation outcomes
+- contents: matches("summary")
+- title: Forecasting
+  desc: Predict future values of your variables
+- contents: matches("forecast")
+- title: Structural analyses
+  desc: Compute interpretable outcomes
+- contents: matches("compute")
+- title: Plot your results
+  desc: Prepare beautiful and informative plots for your analyses
+- contents: matches("plot")
+