kraemer-lab / vneyard

Repository for GRAPEVNE modules
MIT License
0 stars 2 forks source link

New module: importation-analyser (fertree) #5

Closed joetsui1994 closed 6 months ago

joetsui1994 commented 10 months ago

Pre-check:

Proposed module name [e.g. 'Download file']: importation-analyser (fertree) Proposed category [e.g. 'Tutorial']: discrete-phylogeography Description of module: A pipeline that identifies viral lineage imports and extract relevant metadata, given a location-annotated dated phylogeny (using an existing Rust tool known as fertree).

Is this module based on an existing software package [Y/N]: Y If yes, please find a link to the package (preferably the github): fertree

Describe any alternatives you've considered: N/A

Add any other context or screenshots about the feature request here: N/A

joetsui1994 commented 10 months ago

TODO: 1) scripts for downloading and installing required Rust version and dependencies 2) scripts for running fertree 3) scripts for processing output from fertree and generating relevant plots

joetsui1994 commented 9 months ago

fertree is a package written in RUST, and can be found here. There is a specific commit required.

The command for installation (in a dockerfile is as follows):

# Rust and fertree
FROM rust:1.51 as rust
WORKDIR /root
RUN git clone https://github.com/jtmccr1/fertree.git
WORKDIR /root/fertree
RUN git checkout 5c7947d
RUN cargo install --path .

How do I implement this in a module?

joetsui1994 commented 6 months ago

This module is now done.