Skip to content

Commit 52e9a08

Browse files
authored
Add pkgdown website (#19)
* Add pkgdown website * Fix minor README naming issue * Increment version to 0.2.0.9003
1 parent f17c71e commit 52e9a08

File tree

7 files changed

+79
-5
lines changed

7 files changed

+79
-5
lines changed

.Rbuildignore

+3
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,6 @@ misc/
99
^cran-comments\.md$
1010
^\.github$
1111
^CRAN-SUBMISSION$
12+
^_pkgdown\.yml$
13+
^docs$
14+
^pkgdown$

.github/workflows/pkgdown.yaml

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2+
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
3+
on:
4+
push:
5+
branches: [main, master]
6+
pull_request:
7+
branches: [main, master]
8+
release:
9+
types: [published]
10+
workflow_dispatch:
11+
12+
name: pkgdown
13+
14+
jobs:
15+
pkgdown:
16+
runs-on: ubuntu-latest
17+
# Only restrict concurrency for non-PR jobs
18+
concurrency:
19+
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
20+
env:
21+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
22+
permissions:
23+
contents: write
24+
steps:
25+
- uses: actions/checkout@v4
26+
27+
- uses: r-lib/actions/setup-pandoc@v2
28+
29+
- uses: r-lib/actions/setup-r@v2
30+
with:
31+
use-public-rspm: true
32+
33+
- uses: r-lib/actions/setup-r-dependencies@v2
34+
with:
35+
dependencies: '"hard"'
36+
extra-packages: |
37+
any::nbpMatching
38+
any::Rglpk
39+
any::survival
40+
any::pkgdown
41+
local::.
42+
needs: website
43+
44+
- name: Build site
45+
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
46+
shell: Rscript {0}
47+
48+
- name: Deploy to GitHub pages 🚀
49+
if: github.event_name != 'pull_request'
50+
uses: JamesIves/[email protected]
51+
with:
52+
clean: false
53+
branch: gh-pages
54+
folder: docs

.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@
55
misc/
66
inst/doc
77
data-raw/randhrs1992_2016v1.dta
8-
data/hrs_wealthshock.rda
8+
data/hrs_wealthshock.rda
9+
docs

DESCRIPTION

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: rsmatch
22
Title: Matching Methods for Time-Varying Observational Studies
3-
Version: 0.2.0.9002
3+
Version: 0.2.0.9003
44
Authors@R: c(
55
person("Sean", "Kent", , "[email protected]", role = c("aut", "cre", "cph"),
66
comment = c(ORCID = "0000-0001-8697-9069")),
@@ -19,7 +19,7 @@ Description: Implements popular methods for matching in time-varying
1919
speed; the 'gurobi' R package and associated software can be
2020
downloaded from <https://www.gurobi.com> after obtaining a license.
2121
License: MIT + file LICENSE
22-
URL: https://github.com/skent259/rsmatch
22+
URL: https://skent259.github.io/rsmatch/, https://github.com/skent259/rsmatch
2323
BugReports: https://github.com/skent259/rsmatch/issues
2424
Depends:
2525
R (>= 2.10)

README.Rmd

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The R package rsmatch implements various forms of **matching on time-varying obs
2424
Currently, we have methods for:
2525

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

2929
## Installation
3030

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Currently, we have methods for:
2323
- **Balanced Risk Set Matching** with `brsmatch()`, based on the work of
2424
Li, Propert, and Rosenbaum (2001)
2525
- **Propensity Score Matching with Time-Dependent Covariates** with
26-
`coxph_match()`, based on the work of Lu (2005)
26+
`coxpsmatch()`, based on the work of Lu (2005)
2727

2828
## Installation
2929

_pkgdown.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
url: https://skent259.github.io/rsmatch/
2+
template:
3+
bootstrap: 5
4+
5+
reference:
6+
- title: "Matching methods"
7+
contents:
8+
- brsmatch
9+
- coxpsmatch
10+
- title: "Built in data set"
11+
contents:
12+
- oasis
13+
14+
authors:
15+
Sean Kent:
16+
href: "https://github.com/skent259"

0 commit comments

Comments
 (0)