Skip to main content

Fungal Validation & Identification Pipeline

Project description

FunVIP DOI

FunVIP is now published please cite:

Seo CW, Yoo S, Cho Y, Kim JS, Steinegger M, Lim YW. FunVIP: Fungal Validation and Identification Pipeline based on phylogenetic analysis. J. Microbiol. 2025;63(4):e2411017.



Fungal Validation & Identification Pipeline

An automatic tree-based sequence identification and validation pipeline for fungal (or maybe other) species

  • Automatic tree-based identification
  • Works with multiple genetic marker
  • Database sequence validation algorithm implemented

figure1 - ver17A

Bug reports are always welcomed

IMPORTANT NOTICE: The python dependency for Linux platform has changed from 3.12 to 3.11 for TCS inclusion. Please remake conda environment for FunVIP 0.3.25 update

Tutorial

Documentation

Requirements

  • Conda or Mamba environment

* See here for how to install conda environment

* Recently, Mamba is a lot faster than conda. See here to how to install mamba environment

Installation

Usage

FunVIP --db {Your database file} --query {Your query file} --email {Your email} --gene {Your genes} --preset {fast or accurate}

Example

FunVIP --db Penicillium.xlsx --query Query.xlsx --email {Your email} --thread 8 --gene ITS BenA RPB2 CaM --preset fast

* See documentation for detailed usage

How to make database?

figure1 - ver17B

See example database here

Results

  • Section Assignment.xlsx : Your clustering result is here. You can find which of your sequences are clustered to which section

  • Identification_result.xlsx : Your final identification result. Shows how your sequences were assigned to species level through tree-based identification

  • report.xlsx : overall statistics about the tree. If your find taxon ends with numbers, these taxon are found to be paraphyletic, so should be checked

  • /Tree/{section}_{gene}.svg : Final collapsed tree in svg format. Can be edited in vector graphics programs, or in powerpoint (by ungroup)

  • /Tree/{section}_{gene}_original.svg : Uncollapsed tree for inspection

  • Example output tree of FunVIP image

Scheduling

  1. Beta release part 1 (2023 Feburary ~ As paper published, ver 0.3) Will be tested by our lab memebers to fix bugs and advance features
  2. Beta release part 2 (As paper published ~ When pipeline gets stabled, ver 0.4) Will be tested by peer taxonomists
  3. Stable release (ver 1.0)

License

GPL 3.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

funvip-0.5.4.tar.gz (64.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

funvip-0.5.4-py3-none-any.whl (64.5 MB view details)

Uploaded Python 3

File details

Details for the file funvip-0.5.4.tar.gz.

File metadata

  • Download URL: funvip-0.5.4.tar.gz
  • Upload date:
  • Size: 64.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for funvip-0.5.4.tar.gz
Algorithm Hash digest
SHA256 5b7a3ec910b685c3030185695b48087bf0bc8d6baab33e48430a04d50ae3eab9
MD5 1359d885a93ba2a9b636a16f0acd5068
BLAKE2b-256 c2075782ce10c8de92daeaedc7219d82c1db2d5590f8e533449f56632a062934

See more details on using hashes here.

File details

Details for the file funvip-0.5.4-py3-none-any.whl.

File metadata

  • Download URL: funvip-0.5.4-py3-none-any.whl
  • Upload date:
  • Size: 64.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for funvip-0.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 62ba2af47af76b45cbf7ff333c2a6898b816208bbb299f765c020ebb6edfd2b6
MD5 afa6aa3bc8ad74b7ae0ba4550f8100c6
BLAKE2b-256 0c686efefeed04479eafd132e5757a885496ed0f9b97dbcfcce5a48a7a293023

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page