Package index • pvstackr

Package overview

What pvstackr computes, and the objects that its functions return.

pvstackr pvstackr-package: pvstackr: Bayesian Plausible-Value Analysis with One Calibrated Stacked Fit
pvstackr_object_contracts: Objects returned by pvstackr

Find and check the plausible-value, final-weight and replicate-weight columns of a PISA-style data set.

pv_design() print(<pvstackr_design>): Declare the plausible-value and weight columns
detect_pisa_pv_columns(): Find PISA-style plausible-value columns
detect_pisa_brr_replicate_weights(): Find PISA-style replicate-weight columns

Compute the design-based target for the fixed effects from the BRR-Fay replicate weights and Rubin’s rules, and check or rebuild a saved target.

pv_brr_target() print(<pvstackr_brr_target>): Compute the design-based target for the fixed effects
pv_revalidate_brr_target(): Check a BRR-Fay target or rebuild it in the current format

pv_fit(), the functions for the three methods, and their settings.

pv_fit(): Fit a model to plausible-value data
pv_fit_direct(): Fit a stacked model and calibrate it to a BRR-Fay target
pv_fit_reference(): Combine one fit per plausible value with Rubin's rules
pv_fit_stack_psis(): Reweight stacked draws toward each plausible value
pv_control() print(<pvstackr_control>): Settings for the fitting functions

The fitting functions of the bundled brms engine, which you can reuse when you supply fitting functions of your own.

pv_backend_brms_fit_function() pv_backend_brms_draws_function() pv_backend_brms_sampler_diagnostics(): Bundled brms engine for the stacked fit

Put fits made with different methods side by side, with agreement diagnostics.

Read the estimate table, the target, the draws and the diagnostics of a fit.

Print methods for all pvstackr objects, and summary methods for fits and comparisons.

print(<pvstackr_fit>) summary(<pvstackr_fit>) print(<summary.pvstackr_fit>): Print and summarize a fit
print(<pvstackr_method_comparison>) summary(<pvstackr_method_comparison>) print(<summary.pvstackr_method_comparison>): Print and summarize a method comparison

Read stack_psis fits saved by an earlier version of pvstackr.

pv_migrate_legacy_psis_fit() print(<pvstackr_legacy_psis_inspection>) summary(<pvstackr_legacy_psis_inspection>) print(<summary.pvstackr_legacy_psis_inspection>): Inspect a stack_psis fit saved by an earlier version of pvstackr