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. Link



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.5.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.5-py3-none-any.whl (64.5 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: funvip-0.5.5.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.5.tar.gz
Algorithm Hash digest
SHA256 5bd4daf7a954a47979d2a25207a6e15bd423038e7b22354de11b60293ce1b689
MD5 3a6b7231a1745553150036fde3d6dad8
BLAKE2b-256 4edda94970b83e09625bf1ffdbd941e097661ae79a5619559aa04c58c66b5ab0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: funvip-0.5.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 fa10a46afb64306c94dfc90049ee5f2d4f5724a377537d1709af983657a9e1e7
MD5 a362bfc0abe021b8967cdbd12a737d59
BLAKE2b-256 5451caf80eb9b3a7c2b701c22334e50349ca18920f3f660c6ed4ea4f8ae75226

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