Package: PUMP 1.0.4

Luke Miratrix

PUMP: Power Under Multiplicity Project

Estimates power, minimum detectable effect size (MDES) and sample size requirements. The context is multilevel randomized experiments with multiple outcomes. The estimation takes into account the use of multiple testing procedures. Development of this package was supported by a grant from the Institute of Education Sciences (R305D170030). For a full package description, including a detailed technical appendix, see <doi:10.18637/jss.v108.i06>.

Authors:Luke Miratrix [aut, cre], Kristen Hunter [aut], Zarni Htet [aut], Kristin Porter [aut], MDRC [cph], Institute of Education Sciences [fnd]

PUMP_1.0.4.tar.gz
PUMP_1.0.4.zip(r-4.7-any)PUMP_1.0.4.zip(r-4.6-any)PUMP_1.0.4.zip(r-4.5-any)
PUMP_1.0.4.tgz(r-4.6-any)PUMP_1.0.4.tgz(r-4.5-any)
PUMP_1.0.4.tar.gz(r-4.7-any)PUMP_1.0.4.tar.gz(r-4.6-any)
PUMP_1.0.4.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION
card.svg |card.png
PUMP/json (API)

# Install 'PUMP' in R:
install.packages('PUMP', repos = c('https://mdrcny.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/mdrcny/pump/issues

Pkgdown/docs site:https://mdrcny.github.io

On CRAN:

Conda:

6.27 score 8 stars 13 scripts 513 downloads 29 exports 95 dependencies

Last updated from:d9b3c29528. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-develOK182
source / vignettesOK363
linux-releaseOK169
macos-releaseOK187
macos-oldrelOK232
windows-develOK125
windows-releaseOK127
windows-oldrelOK102
wasm-releaseOK119

Exports:calc_dfcheck_corconvert_paramsd_mdesigngen_base_sim_datagen_cluster_idsgen_corr_matrixgen_sim_datagen_T.xgen_Yobsget_power_resultsis.pumpgridresultis.pumpresultparamsparse_d_mpower_curveprint_contextpump_infopump_mdespump_mdes_gridpump_powerpump_power_gridpump_samplepump_sample_gridpump_typesearch_pathtranspose_power_tableupdate_grid

Dependencies:abindbackportsbitbit64bootbroomcarcarDataclicliprcodetoolscolorspacecorrplotcowplotcpp11crayonDerivdigestdoBydplyrfarverforecastFormulafracdifffuturegenericsggplot2ggpubrggrepelggsciggsignifggthemesglobalsgluegridExtragtablehmsisobandlabelinglatticelifecyclelistenvlme4lmtestmagrittrMASSMatrixMatrixModelsmgcvminqamodelrmvtnormnlmenloptrnnetnumDerivparallellypbkrtestpillarpkgconfigpolynomprettyunitsprogresspurrrquantregR6randomizrrbibutilsRColorBrewerRcppRcppArmadilloRcppEigenRdpackreadrreformulasrlangrstatixS7scalesSparseMstringistringrsurvivaltibbletidyrtidyselecttimeDatetzdburcautf8vctrsviridisLitevroomwithrzoo

Demonstration of the PUMP package
Abstract | Introduction | Case study: Diplomas Now | User choices | Designs and models | Multiple testing procedures | Model parameters | Package illustration | Establishing needed design parameters | Calculating MDES | Determining necessary sample size | Comparing adjustment procedures | Exploring sensitivity to design parameters | Exploring power with update() | Exploring the impact of the ICC | Exploring the impact of rho | Exploring the impact of null outcomes | Methods for PUMP objects | References
Rendered frompump_demo.Rmdusingknitr::rmarkdown

Last update: 2025-01-24
Started: 2021-06-16

Demo of simulating multi-level data
Purpose of this vignette | Generating data | Generating for single outcome | Getting components separately | Choosing parameter values | Simulation process
Rendered frompump_simulate.Rmdusingknitr::rmarkdown

Last update: 2025-01-24
Started: 2021-12-20

Demo and discussion of the pump_sample method
Introduction | Intepreting sample size calculations | Exploring a range of sample size values | Flat power curves | Non-Convergence | Note: Non-convergence for feasible designs
Rendered frompump_sample_demo.Rmdusingknitr::rmarkdown

Last update: 2022-09-14
Started: 2021-10-08

Readme and manuals

Help Manual

Help pageTopics
Calculate degrees of freedom (support function)calc_df
Check correlation of test statistics (simulation function)check_cor
Converts model params into DGP params (simulation function)convert_params
Generate base simulated multi-level data (simulation function)gen_base_sim_data
Generates school and district assignments (simulation function)gen_cluster_ids
Generate correlation matrix (simulation function)gen_corr_matrix
Generate simulated multi-level data (simulation function)gen_sim_data
Generate treatment assignment vector (simulation function)gen_T.x
Generate observed outcomes (simulation function)gen_Yobs
Calculates different definitions of power (support function)get_power_results
Return characteristics of a given context/d_m code (support function)parse_d_m
Plot a pumpgridresult object (result function)plot.pumpgridresult
Plot a pumpresult object (result function)plot.pumpresult
Obtain a power curve for a range of sample size or MDES valuespower_curve
Print context (design, model, parameter values) of pumpresult or pumpgridresult (result function)print_context
Provides details about supported package features (core function)pump_info
Estimate the minimum detectable effect size (MDES) (core function)pump_mdes
Run pump_mdes on varying values of parameters (grid function)pump_mdes_grid
Estimate power across definitions (core function)pump_power
Run pump_power on varying values of parameters (grid function)pump_power_grid
Estimate the required sample size (core function)pump_sample
Run pump_sample on varying values of parameters (grid function)pump_sample_grid
Result object for results of grid power calculationsis.pumpgridresult print.pumpgridresult pumpgridresult summary.pumpgridresult
pumpresult object for results of power calculationsas.data.frame.pumpresult design dim.pumpresult d_m is.pumpresult params print.pumpresult pumpresult pump_type search_path summary.pumpresult [.pumpresult [[.pumpresult
Convert power table from wide to long (result function)transpose_power_table
Update a single pump call to a grid call (grid function)update_grid
Update a pump grid call, tweaking some parameters (core function)update.pumpgridresult
Update a pump call, tweaking some parameters (core function)update.pumpresult