Skip to content

Commit

Permalink
Add pkgdown website
Browse files Browse the repository at this point in the history
  • Loading branch information
skent259 committed Feb 20, 2024
1 parent f17c71e commit 8552758
Show file tree
Hide file tree
Showing 7 changed files with 73 additions and 5 deletions.
3 changes: 3 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,6 @@ misc/
^cran-comments\.md$
^\.github$
^CRAN-SUBMISSION$
^_pkgdown\.yml$
^docs$
^pkgdown$
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@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
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@
misc/
inst/doc
data-raw/randhrs1992_2016v1.dta
data/hrs_wealthshock.rda
data/hrs_wealthshock.rda
docs
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: rsmatch
Title: Matching Methods for Time-Varying Observational Studies
Version: 0.2.0.9002
Version: 0.2.0.9003
Authors@R: c(
person("Sean", "Kent", , "skent259@gmail.com", role = c("aut", "cre", "cph"),
comment = c(ORCID = "0000-0001-8697-9069")),
Expand All @@ -19,7 +19,7 @@ Description: Implements popular methods for matching in time-varying
speed; the 'gurobi' R package and associated software can be
downloaded from <https://www.gurobi.com> after obtaining a license.
License: MIT + file LICENSE
URL: https://github.com/skent259/rsmatch
URL: https://skent259.github.io/rsmatch/, https://github.com/skent259/rsmatch
BugReports: https://github.com/skent259/rsmatch/issues
Depends:
R (>= 2.10)
Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The R package rsmatch implements various forms of **matching on time-varying obs
Currently, we have methods for:

- **Balanced Risk Set Matching** with `brsmatch()`, based on the work of Li, Propert, and Rosenbaum (2001)
- **Propensity Score Matching with Time-Dependent Covariates** with `coxph_match()`, based on the work of Lu (2005)
- **Propensity Score Matching with Time-Dependent Covariates** with `coxpsmatch()`, based on the work of Lu (2005)

## Installation

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Currently, we have methods for:
- **Balanced Risk Set Matching** with `brsmatch()`, based on the work of
Li, Propert, and Rosenbaum (2001)
- **Propensity Score Matching with Time-Dependent Covariates** with
`coxph_match()`, based on the work of Lu (2005)
`coxpsmatch()`, based on the work of Lu (2005)

## Installation

Expand Down
16 changes: 16 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
url: https://skent259.github.io/rsmatch/
template:
bootstrap: 5

reference:
- title: "Matching methods"
contents:
- brsmatch
- coxpsmatch
- title: "Built in data set"
contents:
- oasis

authors:
Sean Kent:
href: "https://github.com/skent259"

0 comments on commit 8552758

Please sign in to comment.