Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 4.22 KB

README.md

File metadata and controls

61 lines (43 loc) · 4.22 KB
Raw

FAVITES-Lite FAVITES-Lite Tests Status

FAVITES-Lite is a lightweight framework for viral transmission and evolution simulation. It is a spin-off of FAVITES that is designed to be much simpler and faster, but at the expense of reduced flexibility. FAVITES-Lite was designed to incorporate the just key functionality of FAVITES that most users require. In general, we strongly recommend using FAVITES-Lite instead of FAVITES for epidemic simulation projects.

Installation

FAVITES-Lite is written in Python and depends on the following Python packages:

FAVITES-Lite also calls many command-line tools, which must be installed in your PATH:

To install FAVITES-Lite itself, you can either download the latest release, or you can clone this GitHub repository:

git clone https://github.com/niemasd/FAVITES-Lite.git

FAVITES-Lite is also available on Bioconda. Assuming you have already installed conda (or equivalent) and added the bioconda channel, you can install FAVITES-Lite as well as all of its dependencies as follows:

conda install favites_lite

For convenience, you can also use the FAVITES-Lite Docker image, or you can refer to the Dockerfile for installation commands.

Usage

There are two primary components to FAVITES-Lite: the Config Designer and the FAVITES-Lite executable.

Config Designer

The Config Designer is a tool that helps users design a FAVITES-Lite configuration file for their unique simulation experiment design. Unlike the original FAVITES, in which users had to navigate the documentation to manually design a configuration file, the FAVITES-Lite Config Designer guides the user and includes detailed information about all model choices for all steps of the simulation workflow.

The Config Designer web app was developed by my students: Grant Cheng, Jenny Lam, Justyce Granda, Kathy Chen, Helena Hundhausen, and Daniel Ji.

FAVITES-Lite Executable

The FAVITES-Lite executable (favites_lite.py) actually executes a given simulation experiment, and it can be used as follows:

usage: favites_lite.py [-h] -c CONFIG -o OUTPUT [--overwrite] [--quiet] [--version]

  -h, --help                   show this help message and exit
  -c CONFIG, --config CONFIG   FAVITES-Lite Config File
  -o OUTPUT, --output OUTPUT   Output Directory
  --overwrite                  Overwrite output directory if it exists (default: False)
  --quiet                      Suppress Log Messages (default: False)
  --version                    Show FAVITES-Lite version (default: False)

Scripts

To aid with common downstream analyses, you can find some helper scripts in the scripts folder of this repository. The scripts will be organized by step(s) of the FAVITES-Lite simulation workflow, and each subdirectory will have a README describing the scripts in that folder.

Citing FAVITES-Lite

We are currently working on a manuscript for FAVITES-Lite. For now, if you use FAVITES-Lite in your work, please cite the original FAVITES paper:

Moshiri N, Ragonnet-Cronin M, Wertheim JO, Mirarab S (2018). "FAVITES: simultaneous simulation of transmission networks, phylogenetic trees, and sequences." Bioinformatics. 35(11):1852-1861. doi:10.1093/bioinformatics/bty921