A tool to search for molecular markers with potential impact on the biological characteristics of Influenza A viruses of the A(H5N1) subtype.
Project description
FluMut
FluMut is an open-source tool designed to search for molecular markers with potential impact on the biological characteristics of Influenza A viruses of the A(H5N1) subtype, starting from complete or partial nucleotide genome sequences.
For the complete documentation please visit FluMut site.
Installation
Prerequisites
FluMut is available for Windows, Linux and macOS.
Pip
FluMut is available on PyPI. Before installing FluMut via Pip you need:
Then, you can install FluMut with this command:
pip install flumut
Bioconda
FluMut is also available on Bioconda. You can install using Conda or Mamba.
- Mamba (recommended)
mamba install -c bioconda flumut
conda install -c bioconda flumut
FluMutGUI
The graphical version at the moment is available only for Windows OS. We plan to release it also for MacOS and Linux. Download the installer and follow the instructions. Check out how to use it on complete documentation.
Usage
Input
FluMut can analyze multiple A(H5N1) Influenza virus sequences simultaneously. It can handle partial and complete genome sequences of multiple samples. You must provide a single file containing all the nucleotide sequences in FASTA format. Sequences must adhere to the IUPAC code.
FluMut relies on the FASTA header to assign the sequence to a specific segment and sample.
For this reason, the header must contain both a sample ID (consistent among sequences of the same sample) and one of the the following segment names: PB2
, PB1
, PA
, HA
, NP
, NA
, MP
, NS
.
An example of input file can be downloaded here.
Basic usage
You can get the output file in an Excel format (user-friendly) running:
flumut -x excel_output.xlsm your_fasta.fa
If you prefer the text outputs (machine-readable format) run:
flumut -m markers_output.tsv -M mutations_output.tsv -l literature_output.tsv your_fasta.fa
Update database
You should always use the latest version of our database and you can do it just by running this command:
flumut --update
Outputs
FluMut can produce an Excel output or text outputs:
By default FluMut reports only markers where all mutations are found.
You can report all markers where at least one mutation is found using option -r
/--relaxed
.
Excel
This is the most user-friendly and complete output.
You can obtain this output using the -x
/--excel-output
option.
Find out more here.
IMPORTANT: To enable the navigation feature the exstension of the Excel file must be
.xlsm
. If you don't care about navigation, you can use.xlsx
exstension. Other exstensions lead to unreadable files.
Text outputs
You can obtain 3 different text outputs:
Option | Output | Desctription |
---|---|---|
-m /--markers-output |
Markers output | List of detected markers |
-M /--mutations-output |
Mutations output | List of amino acids present in the positions of mutations of interest for each sample |
-l /--literature-output |
Literature output | List of all papers present in the database |
Cite FluMut
We are currently writing the paper. Until the publication please cite the GitHub repository:
https://github.com/izsvenezie-virology/FluMut
License
FluMut is licensed under the GNU Affero v3 license (see LICENSE).
Fundings
This work was supported by FLU-SWITCH Era-Net ICRAD (grant agreement No 862605) and by the NextGeneration EU-MUR PNRR Extended Partnership initiative on Emerging Infectious Diseases (Project no. PE00000007, INF-ACT)
Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union or the European Health and Digital Executive Agency (HEDEA). Neither the European Union nor the granting authority can be held responsible for them
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
Built Distribution
File details
Details for the file flumut-0.6.3.tar.gz
.
File metadata
- Download URL: flumut-0.6.3.tar.gz
- Upload date:
- Size: 91.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2feb731cc53316c0ede3f8f82d31c35d9b58d3b27fcffa0d6d35002d88b22c17 |
|
MD5 | 4001fbd21303d0bbddf47feb6a7359fb |
|
BLAKE2b-256 | a9a8270907da78092a78e806939f123659cc93db4ffcdf7a3c7a72671d23223d |
File details
Details for the file flumut-0.6.3-py3-none-any.whl
.
File metadata
- Download URL: flumut-0.6.3-py3-none-any.whl
- Upload date:
- Size: 77.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | add747c270ce97cf8c2c9ca944817904ff4fb3658cfd8d836ce161958630e653 |
|
MD5 | b086ea91061d204cb86524573a06f739 |
|
BLAKE2b-256 | 54c9f8180bf8830b785a0acb0eee000c7b8d756996c98044b4dad6797c5002dc |