README.md

In mashr: Multivariate Adaptive Shrinkage

mashr: Multivariate Adaptive Shrinkage in R

This package implements methods to estimate and test many effects in many conditions (or many effects on many outcomes).

Empirical Bayes methods are used to estimate patterns of similarity among conditions, then exploit these patterns of similarity among conditions to improve accuracy of effect estimates. See Urbut et al for details.

Note: the R package used to generate the results for the manuscript is here.

Quick Start

1. Install mashr from CRAN: install.packages("mashr"). For more detailed setup instructions, see below.

2. See the introductory vignette for an introduction to mashr.

3. Then walk through these vignettes to learn more about mashr: Introduction to mash: data-driven covariances and Simulation with non-canonical matrices.

Citing this work

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

Sarah Urbut, Gao Wang, Peter Carbonetto and Matthew Stephens (2019). Flexible statistical methods for estimating and testing effects in genomic studies with multiple conditions. Nature Genetics 51, 187-195.

Setup

The simplest and quickest to obtain mashr is to install it from CRAN:

install.packages("mashr")

For Mac and Windows, usually the package is precompiled, so no additional compiler setup is required. If you have Linux, and in some other rare cases, you will need to make sure that your R installation is properly set up to compile packages with C++ source; in particular, the C++ compiler programs supported by your version of R should be installed on your computer, and R should be correctly configured to call these compilers when installing packages from source. For more information, see the CRAN documentation.

Alternatively, you may use remotes to install the latest version of mashr from GitHub:

install.packages("remotes")
remotes::install_github("stephenslab/mashr")

This command should automatically install any missing dependencies that are available from CRAN and GitHub.

Developer notes

• When any changes are made to roxygen2 markup or the C++ code in the src directory, run devtools::document() to update the RcppExports.cpp, the package namespaces (see NAMESPACE), and the package documentation files (in the "man" subdirectory),

• These are the R commands to build the website (make sure you are connected to Internet while running these commands):

R pkgdown::build_site(lazy=TRUE, examples=FALSE)

• After editing C++ code in the src directory, please use uncrustify to format the code using configuration file inst/misc/uncrustify_default.cfg. For example:

bash uncrustify -c uncrustify_default.cfg --replace --no-backup -l CPP mash.cpp

• Prior to submitting the package to CRAN, the following modifications need to be made: (1) remove the Remotes: entry in DESCRIPTION; and (2) remove the flash_mash.Rmd vignette.

mashr documentation built on Oct. 18, 2023, 5:08 p.m.