pkgdown

.gitignore

@@ -3,4 +3,10 @@
 .Rdata
 .httr-oauth
 .DS_Store
+
 docs
+pkgdown
+
+*.tmp
+*.bak
+*.swp

NEWS.md

@@ -0,0 +1,5 @@
+# causaltbl 0.1.0
+
+* Initial package release
+* `causal_tbl` class which tracks causal-inference-related columns
+* `causal_idx` type which can keep track of relationships between rows

R/causal_idx.R

@@ -30,6 +30,8 @@ new_causal_idx <- function(x = list()) {
 #' print(idx)
 #' idx[1:2] # subsetting
 #' idx[c(2, 1, 3)] # reordering
+#'
+#' @order 1
 #' @export
 causal_idx <- function(x = list()) {
     # convert each element to an integer

R/causal_tbl.R

@@ -125,6 +125,7 @@ reconstruct.causal_tbl <- function(data, old) {
 #' is_causal_tbl(data)
 #' print(data)
 #'
+#' @order 1
 #' @export
 causal_tbl <- function(..., .outcome=NULL, .treatment=NULL) {
     data = vctrs::df_list(...)

_pkgdown.yml

@@ -1,4 +1,19 @@
 url: http://corymccartan.com/causaltbl/
 template:
   bootstrap: 5
+reference:
+- title: Causal data frames
+  contents:
+  - causal_tbl
+  - set_treatment
+  - set_outcome
+  - set_panel
+- title: Special types
+  desc: '`vctrs`-friendly types that are useful for causal inference'
+  contents:
+  - causal_idx
+- title: 'Extend `causal_tbl`'
+  desc: Developer-facing functions
+  contents:
+  - causal_cols