pkgdown basics

version 0.2 #26

Author: donotdespair

.Rbuildignore

@@ -4,3 +4,6 @@
 ^LICENSE\.md$
 ^\.github$
 ^inst/varia$
+^_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

@@ -7,3 +7,4 @@
 *.so
 *.so
 *.o
+docs

_pkgdown.yml

@@ -0,0 +1,56 @@
+url: http://bvarPANELs.org/bvarPANELs/
+template:
+  bootstrap: 5
+
+development:
+  mode: auto
+
+navbar:
+  structure:
+    right: [github]
+
+
+reference:
+- title: "bvarPANELs: Forecasting with Bayesian Hierarchical Panel VARs"
+  desc: "Browse package information"
+- contents:
+  - bvarPANELs-package 
+  - bvarPANELs 
+- title: "Data"
+  desc: "Upload sample data set"
+- contents:
+  - ilo_dynamic_panel
+  - ilo_exogenous_variables
+  - ilo_exogenous_forecasts
+  - ilo_conditional_forecasts
+- title: "Model specification"
+  desc: "Choose a model to work with"
+- contents:
+  - matches("specify_bvarPANEL")
+- title: "More detailed model specification"
+  desc: "Adjust or inspect the specified model"
+- contents:
+  - matches("specify_prior")
+  - matches("specify_start")
+  - matches("specify_panel")
+- 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")