Skip to content

Commit

Permalink
Add pkgdown site workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
chjackson committed Aug 23, 2023
1 parent dad9b46 commit 6e30bf0
Show file tree
Hide file tree
Showing 8 changed files with 118 additions and 64 deletions.
84 changes: 44 additions & 40 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,40 +1,44 @@
README.md
\.Rinstignore
vignettes/msm-manual-.+\.eps
vignettes/msm-manual-.+\.pdf
vignettes/msm-manual\.dvi
vignettes/msm-manual\.tex
vignettes/auto
vignettes/.+\.aux
vignettes/.+\.log
vignettes/.+\.toc
vignettes/.+\.bbl
vignettes/.+\.blg
inst/doc/msm-manual.Rnw
Rplots\.ps
tests/slow
tests/test_slow.R
\.gdb_history
\.Rprofile
\.Rhistory
TAGS
INDEX
src/.+\.d
src/.+\.o
src/.+\.so
src/.+\.dll
src/.+\.rc
src/.+\.a
src/Makedeps
\.sh
^\._
chm
\.RData
\.build.timestamp
TODO
_region_.tex
src/doc
^.*\.Rproj$
^\.Rproj\.user$
\.dropbox\.attr
docs
README.md
\.Rinstignore
vignettes/msm-manual-.+\.eps
vignettes/msm-manual-.+\.pdf
vignettes/msm-manual\.dvi
vignettes/msm-manual\.tex
vignettes/auto
vignettes/.+\.aux
vignettes/.+\.log
vignettes/.+\.toc
vignettes/.+\.bbl
vignettes/.+\.blg
inst/doc/msm-manual.Rnw
Rplots\.ps
tests/slow
tests/test_slow.R
\.gdb_history
\.Rprofile
\.Rhistory
TAGS
INDEX
src/.+\.d
src/.+\.o
src/.+\.so
src/.+\.dll
src/.+\.rc
src/.+\.a
src/Makedeps
\.sh
^\._
chm
\.RData
\.build.timestamp
TODO
_region_.tex
src/doc
^.*\.Rproj$
^\.Rproj\.user$
\.dropbox\.attr
docs
^_pkgdown\.yml$
^docs$
^pkgdown$
^\.github$
1 change: 1 addition & 0 deletions .github/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.html
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/[email protected]
with:
clean: false
branch: gh-pages
folder: docs
32 changes: 17 additions & 15 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
.Rproj.user
.Rhistory
.RData
.Ruserdata
src/*.o
src/*.so
src/*.dll
.dropbox.attr
*.Rproj
symbols.rds
*~
vignettes/_region_.tex
vignettes/auto
R/#*
inst/#*
.Rproj.user
.Rhistory
.RData
.Ruserdata
src/*.o
src/*.so
src/*.dll
.dropbox.attr
*.Rproj
symbols.rds
*~
vignettes/_region_.tex
vignettes/auto
R/#*
inst/#*
.Rprofile
docs
3 changes: 2 additions & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ Imports:
survival,mvtnorm,expm
Suggests:
mstate,minqa,doParallel,foreach,numDeriv,testthat,flexsurv
URL: https://github.com/chjackson/msm
URL: https://github.com/chjackson/msm,
https://chjackson.github.io/msm/
BugReports: https://github.com/chjackson/msm/issues
LazyData: yes
Encoding: UTF-8
Expand Down
9 changes: 1 addition & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
msm
===

The development repository for the [msm](http://cran.r-project.org/package=msm) R package for continuous-time multi-state modelling of panel data.
The [msm](http://cran.r-project.org/package=msm) R package for continuous-time multi-state modelling of panel data.


## Installation (stable CRAN version)
Expand All @@ -21,10 +21,3 @@ devtools::install_github('chjackson/msm')
[Multi-state modelling with msm: material from a web-based training course](https://chjackson.github.io/msm/msmcourse/)

[User guide for the current CRAN version](https://cran.r-project.org/web/packages/msm/vignettes/msm-manual.pdf)




### Note

This is the current repository, hosting versions from 1.6.4 onwards. Previous development versions were hosted on [r-forge](https://r-forge.r-project.org/projects/msm/).
4 changes: 4 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
url: https://chjackson.github.io/msm/
template:
bootstrap: 5

1 change: 1 addition & 0 deletions man/msm-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 6e30bf0

Please sign in to comment.