Skip to content

Repository files navigation

flashier

Documentation and vignettes are available here.

Quick start

Install the latest version of flashier from GitHub:

install.packages("remotes")
remotes::install_github("willwerscheid/flashier")

Once you have installed the package, load the package in R:

library(flashier)

Next, run an example analysis of the GTEx data set:

data(gtex)
fl<- flash(gtex,greedy_Kmax=3,backfit=TRUE)

For a more detailed introduction to flashier, see the introductory vignette and, later, the other vignettes.

To learn more, visit the package website, and view the "flash" help page in R:

help("flash")

Citing this work

If you find the flashier package or any of the source code in this repository useful for your work, please cite:

Jason Willwerscheid, Peter Carbonetto and Matthew Stephens. ebnm: an R package for solving the empirical Bayes normal means problem using a variety of prior families. arXiv:2110.00152.

License

Copyright (c) 2018-2024, Jason Willwerscheid, Peter Carbonetto and Matthew Stephens.

All source code and software in this repository are made available under the terms of the MIT license.

Notes

Please note that function names changed in flashier version 0.2.44. If you are using flashier code from previous versions, please make the following substitutions, and note that many parameter names have changed as well:

Old NameNew Name
as.ebnm.fnflash_ebnm
conv.crit.elboflash_conv_crit_elbo_diff
conv.crit.factorsflash_conv_crit_max_chg_F
conv.crit.loadingsflash_conv_crit_max_chg_L
display.elboflash_verbose_elbo
display.elbo.diffflash_verbose_elbo_diff
display.F.max.chgflash_verbose_max_chg_F
display.L.max.chgflash_verbose_max_chg_L
display.max.chgflash_verbose_max_chg
ff.elboflash_fit_get_elbo
ff.est.tauflash_fit_get_est_tau
ff.fixed.tauflash_fit_get_fixed_tau
ff.gflash_fit_get_g
ff.KLflash_fit_get_KL
ff.p2mflash_fit_get_p2m
ff.pmflash_fit_get_pm
ff.tauflash_fit_get_tau
flash.add.greedyflash_greedy
flash.backfitflash_backfit
flash.fitflash_fit
flash.fix.factorsflash_factors_fix
flash.initflash_init
flash.init.factorsflash_factors_init
flash.nullcheckflash_nullcheck
flash.remove.factorsflash_factors_remove
flash.reorder.factorsflash_factors_reorder
flash.set.factors.to.zeroflash_factors_set_to_zero
flash.set.verboseflash_set_verbose
init.fn.defaultflash_greedy_init_default
init.fn.irlbaflash_greedy_init_irlba
init.fn.softImputeflash_greedy_init_softImpute

Credits

The flashier R package was developed by Jason Willwerscheid, Peter Carbonetto and Matthew Stephens, with many other contributors.

About

A faster and angrier package for EBMF.

Resources

Stars

17 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages