Skip to content

Latest commit

 

History

History
65 lines (51 loc) · 2.99 KB

File metadata and controls

65 lines (51 loc) · 2.99 KB

logo

AI-MARRVEL

Documentation Status

AI-MARRVEL (AIM) is an AI system for rare genetic disease diagnosis.

It takes as input patient VCF and phenotype (formatted with HPO) to predict the causal variant(s).
In making prediction, it takes variant annotation from MARRVEL database and more, and generates prediction score + confidence score as output.

You can use AI-MARRVEL from our website or follow the documentation to run locally.

Quick Start

Install Required Data Dependencies

AIM utilizes various databases for variant annotation, all of which have been compiled and are available for download. We use AWS S3 for data access, and the data can be downloaded by following these steps:

  1. Install the AWS CLI: Follow the instructions provided in the AWS CLI Installation Guide.
  2. Navigate to Your Desired Directory: Change to the directory where you want your data dependencies downloaded. For example, in Ubuntu, use:
    cd <desired/folder/path>
  3. Use the following command to sync the S3 bucket to your local directory:
    aws s3 sync s3://aim-data-dependencies-public . --no-sign-request

Get the software

AIM is released as a Docker image for easy distribution. To get it:

docker pull chaozhongliu/aim-lite:latest

Run with your sample

docker run -v <Path to VCF File>:/input/vcf.gz \
           -v <Path to HPO file>:/input/hpo.txt \
           -v <Path to downloaded database>:/run/data_dependencies \
           -v <Path to output folder>:/out \
       chaozhongliu/aim-lite /run/proc.sh [Sample ID] [Reference genome: hg19/hg38] [Memory Limit (G)]

License

AI-MARRVEL is licensed under GPL-3.0. You are welcomed to use it for research purpose.
For business purpose, please contact us for licensing.

Disclaimer

  • Some of the data and software included in the distribution may be subject to third-party constraints. Users of the data and software are solely responsible for establishing the nature of and complying with any such restrictions.
  • AI-MARRVEL provides this data and software in good faith, but make no warranty, express or implied, nor assume any legal liability or responsibility for any purpose for which they are used.