Fix the README title, three help-page titles, and the reference index blurbs

README.md was titled 'randomizr: Tools for random assignment and random
sampling': README.Rmd had the right title and had not been re-knit. It now also
says how to install rdss and 'interference', and shows one helper in use.

conjoint_measurement's title called it an assignment handler, copied from
conjoint_assignment; it now says what it does. Typos fixed in tidy_stan
(regresion, the the), foos_etal (from from), and lag_by_group (withing). The
pkgdown section blurbs for Tidiers, Data, and Utilities were copied from
DeclareDesign's site and described none of their contents; tidy_stan moves to
Tidiers.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Author: acoppock

R/data.R

@@ -24,7 +24,7 @@
 #' @format A data.frame
 "bonilla_tillery"
 
-#' Replication data for Foos, John, Muller, and Cunningham (2021), Journal of Politics (derived from from Dataverse 10.7910/DVN/NDPXND)
+#' Replication data for Foos, John, Muller, and Cunningham (2021), Journal of Politics (derived from Dataverse 10.7910/DVN/NDPXND)
 #'
 #' @format A data.frame
 "foos_etal"

R/helpers-bayesian-regression.R

@@ -1,6 +1,6 @@
 
 
-#' Tidy results from a stanreg regresion and exponentiate the estimated coefficient
+#' Tidy results from a stanreg regression, optionally exponentiating the coefficients
 #'
 #' Note no standard errors or other summary statistics are provided
 #'
@@ -9,7 +9,7 @@
 #' @param x A stanreg fit from stan_glm
 #' @param conf.int Logical indicating whether or not to include a confidence interval in the tidied output. Defaults to FALSE.
 #' @param conf.level The confidence level to use for the confidence interval if conf.int = TRUE. Must be strictly greater than 0 and less than 1. Defaults to 0.95, which corresponds to a 95 percent confidence interval.
-#' @param exponentiate Logical indicating whether or not to exponentiate the the coefficient estimates. Defaults to FALSE. Note that standard errors are not included when \code{exponentiate = TRUE}.
+#' @param exponentiate Logical indicating whether or not to exponentiate the coefficient estimates. Defaults to FALSE. Note that standard errors are not included when \code{exponentiate = TRUE}.
 #' @param ... Other arguments to broom.mixed::tidy
 #'
 #' @return data.frame of results

R/helpers-conjoint-experiments.R

@@ -85,7 +85,9 @@ conjoint_assignment <-
     data
   }
 
-#' Conjoint experiment assignment handler: conducts complete random assignment of all attribute levels
+#' Conjoint experiment measurement handler: records which profile in each task is chosen
+#'
+#' Applies `utility_fn` and, within each subject and task, compares the two profiles and sets `choice` to 1 for the one with the higher utility `U` (the second profile on a tie).
 #'
 #' See https://book.declaredesign.org/experimental-descriptive.html#conjoint-experiments
 #'

R/helpers-difference-in-differences.R

@@ -5,7 +5,7 @@
 #' @param x Vector of values
 #' @param groups Grouping variable
 #' @param n Positive integer of length 1, giving the number of positions to lead or lag by
-#' @param order_by Ordering variable withing group (e.g., time)
+#' @param order_by Ordering variable within group (e.g., time)
 #' @param default Value used for non-existent rows. Defaults to NA.
 #'
 #' @return vector of lagged values

README.Rmd

@@ -9,3 +9,42 @@ title: "rdss: Helper functions for Research Design in the Social Sciences book"
 [![Codecov test coverage](https://codecov.io/gh/DeclareDesign/rdss/graph/badge.svg)](https://app.codecov.io/gh/DeclareDesign/rdss)
 
 Helper functions for using the book [*Research Design in the Social Sciences: Declaration, Diagnosis, Redesign*](https://book.declaredesign.org/) by Blair, Coppock, and Humphreys 2023 (Princeton University Press). 
+
+## Installation
+
+Install the released version from CRAN:
+
+```{r, eval = FALSE}
+install.packages("rdss")
+```
+
+or the development version from GitHub:
+
+```{r, eval = FALSE}
+remotes::install_github("DeclareDesign/rdss")
+```
+
+`estimator_AS_tidy()`, used in the book's section on experiments over networks, also needs the 'interference' package, which is not on CRAN:
+
+```{r, eval = FALSE}
+remotes::install_github("szonszein/interference")
+```
+
+## Example
+
+Each helper fills one step of a declaration in the book, and its help page links to the section that uses it. `lag_by_group()`, for instance, builds the lagged treatment indicator in the difference-in-differences design:
+
+```{r, message = FALSE}
+library(rdss)
+library(dplyr)
+
+panel <-
+  tibble(
+    unit = rep(c("a", "b"), each = 3),
+    period = rep(1:3, times = 2),
+    D = c(0, 1, 1, 0, 0, 1)
+  ) |>
+  mutate(D_lag = lag_by_group(D, groups = unit, n = 1, order_by = period))
+
+panel
+```

README.md

@@ -1,4 +1,4 @@
-randomizr: Tools for random assignment and random sampling
+rdss: Helper functions for Research Design in the Social Sciences book
 ================
 
 [![CRAN
@@ -14,3 +14,56 @@ Helper functions for using the book [*Research Design in the Social
 Sciences: Declaration, Diagnosis,
 Redesign*](https://book.declaredesign.org/) by Blair, Coppock, and
 Humphreys 2023 (Princeton University Press).
+
+## Installation
+
+Install the released version from CRAN:
+
+``` r
+install.packages("rdss")
+```
+
+or the development version from GitHub:
+
+``` r
+remotes::install_github("DeclareDesign/rdss")
+```
+
+`estimator_AS_tidy()`, used in the book’s section on experiments over
+networks, also needs the ‘interference’ package, which is not on CRAN:
+
+``` r
+remotes::install_github("szonszein/interference")
+```
+
+## Example
+
+Each helper fills one step of a declaration in the book, and its help
+page links to the section that uses it. `lag_by_group()`, for instance,
+builds the lagged treatment indicator in the difference-in-differences
+design:
+
+``` r
+library(rdss)
+library(dplyr)
+
+panel <-
+  tibble(
+    unit = rep(c("a", "b"), each = 3),
+    period = rep(1:3, times = 2),
+    D = c(0, 1, 1, 0, 0, 1)
+  ) |>
+  mutate(D_lag = lag_by_group(D, groups = unit, n = 1, order_by = period))
+
+panel
+```
+
+    ## # A tibble: 6 × 4
+    ##   unit  period     D D_lag
+    ##   <chr>  <int> <dbl> <dbl>
+    ## 1 a          1     0    NA
+    ## 2 a          2     1     0
+    ## 3 a          3     1     1
+    ## 4 b          1     0    NA
+    ## 5 b          2     0     0
+    ## 6 b          3     1     0

_pkgdown.yml

@@ -44,7 +44,7 @@ reference:
   - get_rdss_file
 
 - title: Tidy helpers
-  description: These functions declare research design steps
+  description: Wrap estimators from other packages for use in design steps such as `declare_estimator()`
   contents:
   - causal_forest_handler
   - rma_helper
@@ -65,13 +65,14 @@ reference:
   - lag_by_group
 
 - title: Tidiers
-  description: These functions declare research design steps
+  description: Return model fits from other packages as tidy data frames
   contents:
   - tidy.amce
   - tidy.rdrobust
+  - tidy_stan
 
 - title: Data
-  description: These functions operate on declared designs
+  description: Datasets used in the book's examples and exercises
   contents:
   - bonilla_tillery
   - clingingsmith_etal
@@ -81,7 +82,7 @@ reference:
   - lapop_brazil
 
 - title: Utilities
-  description: These functions operate on declared designs
+  description: Format numbers for tables, and the book's ggplot theme and palette
   contents:
   - add_parens
   - format_num
@@ -90,4 +91,3 @@ reference:
   - theme_dd
   - dd_palette
   - hex_add_alpha
-  - tidy_stan