Skip to contents

POWERUP requires R 4.3.0 or newer. Package dependencies are installed through the normal R package installation process; the current package requires XGBoost 3.2.1.1 or newer.

Install from GitHub

install.packages("remotes")
remotes::install_github("hts-lab/powerup")

Check the installed version with:

packageVersion("powerup")
## [1] '1.0.95'

Installing from the repository without a tag or commit installs its current development state. For an archived or published analysis, install the same tag or commit used for that analysis:

remotes::install_github("hts-lab/powerup@<tag-or-commit>")

Training resources

fit_powerup_models() uses XGBoost for model training. n_threads controls the number of threads passed to XGBoost.

models <- fit_powerup_models(prepared, n_threads = 8)

Record the analysis environment

For a reproducible analysis, record the POWERUP version and R session together with the analysis inputs, model settings, and any random seeds used.

packageVersion("powerup")
## [1] '1.0.95'
## R version 4.4.2 (2024-10-31)
## Platform: aarch64-apple-darwin20
## Running under: macOS Sequoia 15.7.3
## 
## Matrix products: default
## BLAS:   /Library/Frameworks/R.framework/Versions/4.4-arm64/Resources/lib/libRblas.0.dylib 
## LAPACK: /Library/Frameworks/R.framework/Versions/4.4-arm64/Resources/lib/libRlapack.dylib;  LAPACK version 3.12.0
## 
## locale:
## [1] en_US.UTF-8/en_US.UTF-8/en_US.UTF-8/C/en_US.UTF-8/en_US.UTF-8
## 
## time zone: America/New_York
## tzcode source: internal
## 
## attached base packages:
## [1] stats     graphics  grDevices utils     datasets  methods   base     
## 
## other attached packages:
## [1] powerup_1.0.95
## 
## loaded via a namespace (and not attached):
##  [1] digest_0.6.37     desc_1.4.3        R6_2.6.1          fastmap_1.2.0    
##  [5] xfun_0.51         cachem_1.1.0      knitr_1.50        htmltools_0.5.8.1
##  [9] rmarkdown_2.29    lifecycle_1.0.4   cli_3.6.5         sass_0.4.9       
## [13] pkgdown_2.2.0     textshaping_1.0.0 jquerylib_0.1.4   systemfonts_1.2.2
## [17] compiler_4.4.2    tools_4.4.2       ragg_1.5.1        bslib_0.9.0      
## [21] evaluate_1.0.3    yaml_2.3.10       jsonlite_2.0.0    rlang_1.1.6      
## [25] fs_1.6.5          htmlwidgets_1.6.4

Continue with Get Started with POWERUP for a compact end-to-end analysis.