Skip to main content

A Python interface of NEFFy C++ tool: NEFF Calculator and MSA File Converter

Project description

NEFFy: NEFF Calculator and MSA File Converter

NEFFy is a versatile and efficient tool for bioinformatics research, offering advanced features for calculating NEFF (Normalized Effective Number of Sequences) for Multiple Sequence Alignments (MSA)s of any biological sequences, including protein, RNA, and DNA across various MSA formats.
Additionally, NEFFy includes built-in support for format conversion, allowing users to seamlessly convert between different MSA formats.

Python Library

Neffy also provides a python library as an interface of the executable files.

Library Usage

An example of neff computation:

cd example
python compute_neff.py

You can find more examples of using the Python library's various methods for NEFF calculations in the examples directory. For method parameters and detailed explanations, please refer to the documentation usage guide.

An example of MSA conversion:

cd example
python convert_msa.py

Additional examples of using NEFFy for MSA conversion can be found in the example directory. For further detailed explanations, please refer to the documentation usage guide.


Supported File Formats

  • A2M (aligned FASTA-like format)
  • A3M (compressed aligned FASTA-like format with lowercase letters for insertions)
  • FASTA, AFA, FAS, FST, FSA (FASTA format)
  • STO (Stockholm format)
  • CLUSTAL (CLUSTAL format)
  • ALN (ALN format)
  • PFAM (format mostly used for nucleotides)

In the documentation, you will find a brief explanation of each format, along with an illustrative alignment example for each one.


Error Handling

If any errors occur during the execution of the MSA Processor, an error message will be displayed, describing the issue encountered.
Please refer to the error message for troubleshooting or make necessary corrections to the input.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Citation

If you use NEFFy in your research, please cite the following:

Maryam Haghani, Debswapna Bhattacharya, T M Murali, NEFFy: A Versatile Tool for Computing the Number of Effective Sequences, Bioinformatics, 2025; https://doi.org/10.1093/bioinformatics/btaf222

Archival DOI

For long-term accessibility and reproducibility, each release of NEFFy is archived with a DOI:

Version DOI
Latest (v0.1.2) 🔗 Zenodo DOI: 10.5281/zenodo.14908220

For further assistance, please see the documentation.

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

neffy-0.1.2.tar.gz (44.0 kB view details)

Uploaded Source

Built Distribution

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

neffy-0.1.2-cp311-cp311-macosx_11_0_arm64.whl (171.6 kB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

File details

Details for the file neffy-0.1.2.tar.gz.

File metadata

  • Download URL: neffy-0.1.2.tar.gz
  • Upload date:
  • Size: 44.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.7

File hashes

Hashes for neffy-0.1.2.tar.gz
Algorithm Hash digest
SHA256 49c256d1ebf441597a299777cfb8eb4fa9a9415054d72657e38b16f6383c5fd1
MD5 5a9b35cb824150e2fbd97ca7463adbb4
BLAKE2b-256 4676419a7c5a46c78066a637159aafdc61831113be4670f015972eaae8b4aa08

See more details on using hashes here.

File details

Details for the file neffy-0.1.2-cp311-cp311-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for neffy-0.1.2-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 edbdbe1be77a1eea43b649145c6c10dc88ffe014a74958aba9c863d97fbb665f
MD5 99262aefd975644623473b75fcd37070
BLAKE2b-256 5ae829e091d9db81b1fc7fb9f711061bec878c0b28abbc3b93372b29e965f2d7

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