This documentation is a work in progress and is incomplete.
Please contact developers for more details.
This page describes the setup process of ELLA anno.
- Docker (opens new window)
- make (
apt install make,
yum install make,
apk add make, etc.)
# Optional requirements
ELLA anno is available in both Docker and Singularity containers. It can also be set up to be used locally, but a container is recommended. We also recommend using buildkit (opens new window) for faster docker builds. You may see a warning about unconsumed arguments if you build the docker images without buildkit installed/enabled, but it doesn't negatively impact the images in any way.
- Clone the repo
git clone email@example.com:alleles/ella-anno
- Check out the desired release
git checkout v2.0.0
- Build the docker images
- Download the annotation datasets
- Generate singularity images (if desired)
# Running ELLA anno
Start the container:
# Annotate options
| ||Input VCF|
| ||Input HGVSC|
| ||Regions to slice input on|
| ||Flag to run conversion only, not annotation|
| ||Output folder (default: working directory)|
| ||Number of cores to use for time-consuming annotation steps (default number of cores available)|