Skip to content

Commit

Permalink
implement pkgdown workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
ygeunkim committed Dec 18, 2023
1 parent be0ec55 commit 35e032b
Show file tree
Hide file tree
Showing 3 changed files with 85 additions and 44 deletions.
48 changes: 48 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Description: Tools to research Bayesian Vector heterogeneous autoregressive (VHA
referring to Kim & Baek (2023) (<doi:10.1080/00949655.2023.2281644>).
'bvhar' can model Vector Autoregressive (VAR), VHAR, Bayesian VAR (BVAR), and Bayesian VHAR (BVHAR) models.
License: GPL (>= 3)
URL: https://ygeunkim.github.io/package/bvhar/, https://github.com/ygeunkim/bvhar
URL: https://ygeunkim.github.io/bvhar/, https://github.com/ygeunkim/bvhar
BugReports: https://github.com/ygeunkim/bvhar/issues
Suggests:
covr,
Expand Down
79 changes: 36 additions & 43 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,40 +1,37 @@
url: https://ygeunkim.github.io/bvhar/
template:
bootstrap: 5
bootswatch: journal
bslib:
bg: "#272935"
fg: "#f8f8f2"
primary: "#ff3860"
secondary: "#23252f"
base_font: {google: "Noto Sans"}
code_font: {google: "Anonymous Pro"}
code-bg: "#44475a"
code-color: "#f8f8f2"
bg: '#272935'
fg: '#f8f8f2'
primary: '#ff3860'
secondary: '#23252f'
base_font:
google: Noto Sans
code_font:
google: Anonymous Pro
code-bg: '#44475a'
code-color: '#f8f8f2'
theme: github-dark

development:
mode: auto

reference:
- title: The bvhar package
desc: ~
contents:
- bvhar-package

contents: bvhar-package
- title: VAR
desc: >
desc: |
Vector autoregressive model.
contents:
- var_lm
- VARtoVMA

- title: VHAR
desc: >
desc: |
Vector heterogeneous autoregressive model.
contents:
- vhar_lm
- VHARtoVMA

- title: Bayesian Model
desc: ~
contents:
Expand All @@ -43,9 +40,8 @@ reference:
- set_ssvs
- set_lambda
- set_horseshoe

- title: BVAR
desc: >
desc: |
Bayesian VAR model.
contents:
- bvar_minnesota
Expand All @@ -54,32 +50,28 @@ reference:
- bvar_sv
- bvar_ssvs
- bvar_horseshoe

- title: BVHAR
desc: >
desc: |
Bayesian VHAR model.
contents:
- bvhar_minnesota
- bvhar_sv
- bvhar_ssvs
- bvhar_horseshoe

- title: Summary method
desc: ~
contents:
- summary.varlse
- summary.vharlse
- summary.normaliw
- summary.ssvsmod

- title: Forecasting
desc: ~
contents:
- predict.varlse
- divide_ts
- forecast_roll
- forecast_expand

- title: Evaluation
desc: ~
contents:
Expand All @@ -103,7 +95,6 @@ reference:
- spne
- relspne
- lpl

- title: Tuning
desc: ~
contents:
Expand All @@ -113,7 +104,6 @@ reference:
- bound_bvhar
- choose_bayes
- choose_ssvs

- title: Information criteria
desc: ~
contents:
Expand All @@ -127,7 +117,6 @@ reference:
- choose_var
- compute_dic
- compute_dic.bvarmn

- title: Plots
desc: ~
contents:
Expand All @@ -139,7 +128,6 @@ reference:
- autoplot.bvharirf
- autoplot.bvharsp
- autoplot.summary.bvharsp

- title: Simulation and Random Generation
desc: ~
contents:
Expand All @@ -154,13 +142,11 @@ reference:
- sim_mvt
- sim_ssvs_var
- sim_horseshoe_var

- title: Data
desc: ~
contents:
- etf_vix
- oxfordman

- title: Other generic functions
desc: ~
contents:
Expand All @@ -174,13 +160,20 @@ reference:
- fitted.varlse
- is.varlse
- split_coef

destination: '../../myprofile/young-blogdown/static/package/bvhar'

destination: ../../myprofile/young-blogdown/static/package/bvhar
navbar:
structure:
left: [intro, reference, articles, tutorials, news, research, accepted]
right: [github, goback]
left:
- intro
- reference
- articles
- tutorials
- news
- research
- accepted
right:
- github
- goback
components:
research:
icon: fa-laptop-code
Expand All @@ -192,18 +185,18 @@ navbar:
href: /software/
aria-label: Back to the page
text: Go back to the Software page

news:
releases:
- text: "JSCS submission ver"
- text: JSCS submission ver
href: https://github.com/ygeunkim/bvhar/releases/tag/v0.9.0
- text: "JSCS revision ver"
- text: JSCS revision ver
href: https://github.com/ygeunkim/bvhar/releases/tag/v0.12.0
- text: "Version 1.0.0"
- text: Version 1.0.0
href: https://github.com/ygeunkim/bvhar/releases/tag/v1.0.0
- text: "Version 1.0.1"
- text: Version 1.0.1
href: https://github.com/ygeunkim/bvhar/releases/tag/v1.0.1
- text: "Version 1.0.2"
- text: Version 1.0.2
href: https://github.com/ygeunkim/bvhar/releases/tag/v1.0.2
- text: "Version 1.1.0"
href: https://github.com/ygeunkim/bvhar/releases/tag/v1.1.0
# - text: Version 1.1.0
# href: https://github.com/ygeunkim/bvhar/releases/tag/v1.1.0

0 comments on commit 35e032b

Please sign in to comment.