CWAS-Plus2 installation

Requirements

For CWAS-Plus2 to run, the users need to (1) install conda and Ensembl Variant Effect Predictor (VEP) and (2) download a few databases for annotation.

1. Required installations

  • Conda: CWAS-Plus2 install packages using conda environment. Please install conda or mamba.

  • Rust: A Rust compiler is required for building the high-performance categorization engine. Install it with:

    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

  • VEP: VEP is used for variant annotation. Please refer to the reference and install VEP.

2. VEP resources

  • Missense database: Missense database containing scores to classify damaging missense variants are required. In CWAS-Plus2, MPC database is available. If users want to use other database, they can download their own database and customize the configuration.txt to use it.

    git clone https://github.com/joonan-lab/cwas-dataset.git

  • loftee plugin: loftee will be used to classify protein-truncating variants. Be aware of which branch you are cloning.

    cd $HOME/.vep/Plugins
wget https://github.com/konradjk/loftee/archive/refs/tags/v1.0.4_GRCh38.tar.gz
tar -zxvf v1.0.4_GRCh38.tar.gz
mv loftee-1.0.4_GRCh38 loftee

  • gerp bigwig: This file will be used for loftee plugin.

    wget https://personal.broadinstitute.org/konradk/loftee_data/GRCh38/gerp_conservation_scores.homo_sapiens.GRCh38.bw

  • Human ancestor fasta: This file will be used for loftee plugin.

    wget https://personal.broadinstitute.org/konradk/loftee_data/GRCh38/human_ancestor.fa.gz
wget https://personal.broadinstitute.org/konradk/loftee_data/GRCh38/human_ancestor.fa.gz.fai
wget https://personal.broadinstitute.org/konradk/loftee_data/GRCh38/human_ancestor.fa.gz.gzi

  • Conservation file: This file will be used for loftee plugin.

    wget https://personal.broadinstitute.org/konradk/loftee_data/GRCh38/loftee.sql.gz
gunzip -k loftee.sql.gz

Install CWAS-Plus2

Users can instasll CWAS-Plus2 through pip or github. We recommend installing under a conda environment to avoid global installation.

  • pip

conda create -n cwas python=3.11
conda activate cwas
pip install cwas-plus2

  • Github

conda create -n cwas python=3.11
conda activate cwas
git clone https://github.com/joonan-lab/cwas-plus2.git
cd cwas-plus2
pip install .

To start CWAS-Plus2, type the command below. This will create a workspace (.cwas) for CWAS-Plus2 in home directory. You can specify the directory that will be used as a working directory. As a default, $HOME/.cwas will be set. If you have a pre-installed VEP, this process will find it automatically and type it to the configuration file.

  • -w: Path to the CWAS working directory. All default CWAS processes will save their output here if no specific output directory is given. By default, the directory is set to $HOME/.cwas.

cwas start -w .cwas_wd