Adding pkgdown site

.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/[email protected]
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

DESCRIPTION

@@ -23,7 +23,7 @@ Maintainer: Stephen Salerno <[email protected]>
 Description: Performs valid statistical inference on predicted data (IPD) using recent methods, where for a subset of the data, the outcomes have been predicted by an algorithm. Provides a wrapper function with specified defaults for the type of model and method to be used for estimation and inference. Further provides methods for tidying and summarizing results. Salerno et al., (2024) <doi:10.48550/arXiv.2410.09665>.
 License: MIT + file LICENSE
 LazyData: true
-URL: https://github.com/ipd-tools/ipd
+URL: https://github.com/ipd-tools/ipd, https://ipd-tools.github.io/ipd, https://ipd-tools.github.io/ipd/
 BugReports: https://github.com/ipd-tools/ipd/issues
 Depends: 
     R (>= 3.5.0)

NEWS.md

@@ -2,12 +2,14 @@
 
 * Added a `NEWS.md` file to track changes to the package.
 
-* `ipd()` now allows for regression through the origin with `intercept = FALSE` argument
+* Added a `pkgdown` site for the package.
+
+* `ipd()` now allows for regression through the origin with `intercept = FALSE` argument.
 
-* `ipd()` now takes an additional argument, `na_action`, to handle missing covariate data
+* `ipd()` now takes an additional argument, `na_action`, to handle missing covariate data.
 
-  * Currently supports `"na.fail"` and `"na.omit"`. Defaults to `na.fail`
+  * Currently supports `"na.fail"` and `"na.omit"`. Defaults to `na.fail`.
 
-  * Provides a more informative error message and lists which covariates are missing observations
+  * Provides a more informative error message and lists which covariates are missing observations.
 
-* `ipd()` now takes an additional argument, `n_t`, which denotes the (optional) size of the training set used to generate the prediction rule. Defaults to `Inf` but is necessary for the `postpi_X` methods if `n_t` < `n`, `N`, the number of labeled and unlabeled observations, respectively, in the data being analyzed
+* `ipd()` now takes an additional argument, `n_t`, which denotes the (optional) size of the training set used to generate the prediction rule. Defaults to `Inf` but is necessary for the `postpi_X` methods if `n_t` < `n`, `N`, the number of labeled and unlabeled observations, respectively, in the data being analyzed.

_pkgdown.yml

@@ -1,6 +1,4 @@
-url: ~
+url: https://ipd-tools.github.io/ipd/
 template:
   bootstrap: 5
-  bslib:
-    primary: "#998972"