lczech / grenedalf

Toolkit for Population Genetic Statistics from Pool-Sequenced Samples, e.g., in Evolve and Resequence experiments
GNU General Public License v3.0
35 stars 2 forks source link
allele-frequencies evolve-and-resequence pool-sequencing poolfstat popoolation popoolation2 population-genetics

Bioconda install Downloads Release CI Softwipe Score Language License

grenedalf

Features

grenedalf is a collection of commands for working with pool sequencing population genetic data. Its main focus are statistical analyses such as Tajima's D and Fst, as well as convenience functions around pool sequencing data. The statistics follow the approaches of PoPoolation and PoPoolation2, as well as poolfstat and npstat. However, compared to those, grenedalf is significantly more scalable, more user friendly, and offers more settings and input file formats.

Setup

We recommend to first try the pre-compiled binaries of the latest Release, by downloading the binary for your system from the "Assets" list below the release. Alternatively, grenedalf can be installed via bioconda. If that does not work, it can be build from source as described here. If you want the best performance, we recommend to build from source anyway.

Usage and Documentation

grenedalf is used via its command line interface, with commands for each task. The commands have the general structure:

grenedalf <command> <options>

See the Wiki pages for the list of all commands and their documentation.

Support and Requests

For questions, bug reports, and feature requests, please open an issue. Please do not send emails with questions or requests, as others might be having them as well, and so it is better to discuss them here where they can be found.

Feedback on functionality, interface, and features is highly appreciated, as we are always open to discussing new statistics and tools that might be relevant for the community. If you need other pool sequencing statistics than the ones already offered here, please reach out - happy to explore the potential for a collaboration there! We have a lot of code infrastructure in grenedalf that takes care of all the basics, and so it would be nice to implement further statistics!

Citation

Please find the publication here:

grenedalf: population genetic statistics for the next generation of pool sequencing.
Lucas Czech, Jeffrey P. Spence, Moisés Expósito-Alonso.
Bioinformatics, 2024. doi:10.1093/bioinformatics/btae508

Each command also prints out the relevant references for that command. Then, the command grenedalf citation can be used to obtain details on those references.