Last updated: 2020-06-23

Checks: 2 0

Knit directory: rss/

This reproducible R Markdown analysis was created with workflowr (version 1.6.2). The Checks tab describes the reproducibility checks that were applied when the results were created. The Past versions tab lists the development history.

R Markdown file: up-to-date

Great! Since the R Markdown file has been committed to the Git repository, you know the exact version of the code that produced these results.

Repository version: 44126fa

Great! You are using Git for version control. Tracking code development and connecting the code version to the results is critical for reproducibility.

The results in this page were generated with repository version 44126fa. See the Past versions tab to see a history of the changes made to the R Markdown and HTML files.

Note that you need to be careful to ensure that all relevant files for the analysis have been committed to Git prior to generating the results (you can use wflow_publish or wflow_git_commit). workflowr only checks the R Markdown file, but you know if there are other scripts or data files that it depends on. Below is the status of the Git repository when the results were generated: 


Ignored files:
    Ignored:    .Rproj.user/
    Ignored:    .spelling
    Ignored:    examples/example5/.Rhistory
    Ignored:    examples/example5/Aseg_chr16.mat
    Ignored:    examples/example5/example5_simulated_data.mat
    Ignored:    examples/example5/example5_simulated_results.mat
    Ignored:    examples/example5/ibd2015_path2641_genes_results.mat

Untracked files:
    Untracked:  docs_old/

Note that any generated files, e.g. HTML, png, CSS, etc., are not included in this status report because it is ok for generated content to have uncommitted changes.

These are the previous versions of the repository in which changes were made to the R Markdown (rmd/setup_vb.Rmd) and HTML (docs/setup_vb.html) files. If you’ve configured a remote Git repository (see ?wflow_git_remote), click on the hyperlinks in the table below to view the files as they were in that past version.

File Version Author Date Message
Rmd 44126fa Xiang Zhu 2020-06-23 wflow_publish(“rmd/setup_vb.Rmd”)

This page shows how to install the Variational Bayes (VB) scripts in rss/src_vb/. In a standard computing environment with internet connection, the installation time is typically less than 10 minutes.

Step-by-step guide

0. Install git (optional)

To simplify Step 1 below, you may consider installing git in your computing environment (if it is not available there). Please see this excellent tutorial on installing git.

Please note that RSS software does not depend on git. You can complete Step 1 without installing git.

1. Clone rss repository

With git installed, you can easily clone rss by running the following command in Terminal.

git clone git@github.com:stephenslab/rss.git

Without git, you can manually download rss as follows.

wget https://github.com/stephenslab/rss/archive/master.zip
unzip master.zip
rm master.zip
mv rss-master rss

2. Compile mex file

Go to rss/src_vb and open MATLAB.

cd rss/src_vb
matlab -nodesktop

Run rss/src_vb/install.m in MATLAB. You may get the following output.

>> run install.m
Building with 'gcc'.
MEX completed successfully.
Compilation of MEX files is complete.

After successfully running rss/src_vb/install.m, you will find a file rss_varbvsr_update_matlab.mexa64 (in Linux) in the directory rss/src_vb, which is the workhorse for variational Bayes computations.

Computing environment

Please note that RSS VB codes have only been extensively tested in the following environments.

If you have any trouble installing RSS VB codes, please open an issue or email me (xiangzhu[at]uchicago[and/or]stanford.edu). To help me better understand your problems, please provide details of your computing environment.

MEX files

The most tricky part of this installation is probably compiling MEX files in MATLAB (Step 2).

Before running rss/src_vb/install.m, please make sure that you have the compiler compatible with your version of MATLAB, and that you can compile the MEX files in the tutorials given on the MathWorks website.

In addition, please ensure that you compile and run the scripts in the same version of MATLAB. For example, if you have compiled MEX files using MATLAB Release R2017b, please use the compiled output rss_varbvsr_update_matlab.mexa64 only in MATLAB R2017b.

For more information on MEX, please see: