First and foremost, thank you for your work on this very promising kinship estimation method, and congratulation on your recently published paper!
I just have a quick suggestion in regards to your documentation, README file, and conda environment definition here. Namely, I think you perhaps forgot to explicitely mention bcftools and samtools as a direct dependency of KINGaroo - since you're running multiple subprocesses of them in helpers.py, if I'm not mistaken.
These softwares do come pre-installed on Ubuntu distrubtions, but may not be available on all UNIX platforms. This may trip up users during their installation process, especially those running your software on HPC environments and/or embedding your software within container infrastructure such as Singularity or Docker.
Maybe providing users with an updated yaml definition file could be of help ? kin-3.1.3-environment.yml would thus be something in the likes of:
Hi,
First and foremost, thank you for your work on this very promising kinship estimation method, and congratulation on your recently published paper!
I just have a quick suggestion in regards to your documentation, README file, and conda environment definition here. Namely, I think you perhaps forgot to explicitely mention
bcftools
andsamtools
as a direct dependency of KINGaroo - since you're running multiple subprocesses of them in helpers.py, if I'm not mistaken.These softwares do come pre-installed on Ubuntu distrubtions, but may not be available on all UNIX platforms. This may trip up users during their installation process, especially those running your software on HPC environments and/or embedding your software within container infrastructure such as Singularity or Docker.
Maybe providing users with an updated yaml definition file could be of help ?
kin-3.1.3-environment.yml
would thus be something in the likes of:Anyway, hope this helps, and thanks again for this great contribution !
Cheers