Set up gh pages and actions test

.Rbuildignore

@@ -1,2 +1,7 @@
 ^.*\.Rproj$
 ^\.Rproj\.user$
+^_pkgdown\.yml$
+^docs$
+^\.github$
+^pkgdown$
+^README\.Rmd$

.github/workflows/R-CMD-check.yaml

@@ -0,0 +1,51 @@
+# 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:
+
+name: R-CMD-check.yaml
+
+permissions: read-all
+
+jobs:
+  R-CMD-check:
+    runs-on: ${{ matrix.config.os }}
+
+    name: ${{ matrix.config.os }} (${{ matrix.config.r }})
+
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {os: macos-latest,   r: 'release'}
+          - {os: windows-latest, r: 'release'}
+          - {os: ubuntu-latest,  r: 'devel', http-user-agent: 'release'}
+          - {os: ubuntu-latest,  r: 'release'}
+          - {os: ubuntu-latest,  r: 'oldrel-1'}
+
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+      R_KEEP_PKG_SOURCE: yes
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          r-version: ${{ matrix.config.r }}
+          http-user-agent: ${{ matrix.config.http-user-agent }}
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::rcmdcheck
+          needs: check
+
+      - uses: r-lib/actions/check-r-package@v2
+        with:
+          upload-snapshots: true
+          build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'

.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

@@ -2,3 +2,6 @@
 .Rhistory
 .RData
 .Ruserdata
+docs/
+inst/doc
+.Renviron

DESCRIPTION

@@ -13,6 +13,9 @@ Authors@R: c(
 Depends: R (>= 3.5.0)
 Description: This is an R package to generate data sets for
     benchmarking methods on heterogenous treatment effects.
+URL: https://openpharma.github.io/benchtm,
+    https://github.com/openpharma/benchtm
+BugReports: https://github.com/openpharma/benchtm/issues
 License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true

README.Rmd

@@ -23,7 +23,7 @@ knitr::opts_chunk$set(
 </colgroup>
 <tr>
 <td align = "left">
-<h3> The <code>{benchtm}</code> aims to generate simulated data sets of heterogeneous treatment effects in clinical trials for benchmarking quantitaive methods. </h3>
+<h3> The <code>{benchtm}</code> aims to generate simulated data sets of heterogeneous treatment effects in clinical trials for benchmarking quantitative methods. </h3>
 </td>
 <td align="center">
 <img src='man/figures/logo.png' align="right" />
@@ -48,14 +48,10 @@ devtools::install_github("openpharma/benchtm")
 ```
 
 ## How to use the package
-An .html vignette with introduction to package can be previewed [here](https://raw.githack.com/openpharma/benchtm/master/docs/articles/index.html).
+An .html vignette with introduction to package can be previewed [here](https://openpharma.github.io/benchtm/articles/index.html).
 
 
 ## Contact us
 - For any questions, please contact: [Sophie Sun](mailto:sophie.sun@novartis.com)
 
 
-
-
-
-

README.md

@@ -15,7 +15,7 @@
 <h3>
 The <code>{benchtm}</code> aims to generate simulated data sets of
 heterogeneous treatment effects in clinical trials for benchmarking
-quantitaive methods.
+quantitative methods.
 </h3>
 </td>
 <td align="center">
@@ -39,7 +39,7 @@ devtools::install_github("openpharma/benchtm")
 ## How to use the package
 
 An .html vignette with introduction to package can be previewed
-[here](https://raw.githack.com/openpharma/benchtm/master/docs/articles/index.html).
+[here](https://openpharma.github.io/benchtm/articles/index.html).
 
 ## Contact us
 

_pkgdown.yml

@@ -1,4 +1,4 @@
-destination: docs
+url: https://openpharma.github.io/benchtm
 
 home:
   links: