Merge pull request #553 from apeterson91/master

Add comment clarifying replicate weights setting
walkerke · Jan 25, 2024 · 2338c25 · 2338c25
2 parents 6d8a589 + ae52084
commit 2338c25
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/R/pums.R b/R/pums.R
@@ -458,6 +458,11 @@ to_survey <- function(df,
   # }
 
   if (design == "rep_weights"){
+    # Arguments are set according to guidance from the ipums documentation
+    # available at https://usa.ipums.org/usa/repwt.shtml#q50.
+    # Although these are successive difference weights use of the "JK1",
+    # jackknife, type setting below with the corresponding arguments
+    # produces equivalent results.
     survey <- survey::svrepdesign(
       variables = variables,
       weights = weights,