From 3c335d6b10bcc5653e3d8cef5b0ff8452af5f7b1 Mon Sep 17 00:00:00 2001 From: Xihao Li Date: Tue, 26 Nov 2024 00:46:34 -0500 Subject: [PATCH] Update README.md --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 0c6f6e5..856fcde 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,22 @@ STAAR is an R package for performing variant-Set Test for Association using Anno For optimal computational performance, it is recommended to use an R version configured with the Intel Math Kernel Library (or other fast BLAS/LAPACK libraries). See the instructions on building R with Intel MKL. ## Dependencies STAAR links to R packages Rcpp and RcppArmadillo, and also imports R packages Rcpp, GMMAT, GENESIS, Matrix. These dependencies should be installed before installing STAAR. + +Note that some dependencies for STAAR may require installation from Bioconductor using a command like the following to install the GENESIS package: + +```r +if (!require("BiocManager", quietly = TRUE)) + install.packages("BiocManager") + +BiocManager::install("GENESIS") +``` ## Installation ``` library(devtools) devtools::install_github("xihaoli/STAAR") ``` + +If you are using a Mac computer, installation of the `STAAR` R package will be simplified by installing the Xcode command line tools (as detailed more at, for example, ). It is also recommended to install the `macrtools` package () to install components (including `gfortran`) that are required to compile some R and Bioconductor packages. ## Docker Image A [docker image for STAAR](https://hub.docker.com/repository/docker/zilinli/staarpipeline), including R (version 3.6.1) built with Intel MKL and all STAAR-related packages (STAAR, MultiSTAAR, SCANG, STAARpipeline, STAARpipelineSummary) pre-installed, is located in the Docker Hub. The docker image can be pulled using ```