Installation

Requirements

1. pip

pip is a Python package manager that makes it much easier to download and install Python packages, as a part of such wbuild and snakemake. If you don’t have pip installed, this Python installation guide can guide you through the process.

Advanced users who want to get the Python packages elsehow can skip this step.

2. snakemake

Snakemake is essential to wBuild workflow (learn why in the Overview of functionality). You can get Snakemake either using pip or building from sources. By installing wBuild from pip you automatically install the Snakemake, should it be absent.

3. R and packages

The original purpose of wBuild’s work is to let you put additional build/dependencies info in your R scripts, so we suppose you have already installed R. Now, the very important step for installation is to install various R packages:

• knitr
• rmarkdown
• pandoc

as Snakemake inevitably uses them while working with wBuild.

You can install packages for R with install.packages(packagename) directive. Find out more for instance here.

Additionally for Windows users

You need to add R_HOME and pandoc home variables to your Path for Snakemake CLI to run correctly. See p.2 in this instruction.

Now, you are all ready and set up to install the wBuild itself.

Stable release

Please make sure you’ve read Requirements first.

To install wBuild, run this command in your terminal:

$ pip install wbuild

From sources

The sources for wBuild can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/wachutka/wbuild

Or download the tarball:

$ curl  -OL https://github.com/wachutka/wbuild/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install