StaPH-B / docker-builds

:package: :whale: Dockerfiles and documentation on tools for public health bioinformatics
GNU General Public License v3.0
187 stars 119 forks source link

add shigapass 1.5.0 #1041

Closed jvhagey closed 1 month ago

jvhagey commented 1 month ago

This PR includes a Dockerfile for ShigaPass v1.5.0

Pull Request (PR) checklist:

kapsakcj commented 1 month ago

Thanks for the PR. Could you please add a step in the app stage to index the database so that users do not need to index prior to running the tool? Perhaps add in another RUN command after line 44 in the dockerfile

I see you have the -u option used in the test stage but it would be helpful to have that done independently in the app stage

jvhagey commented 1 month ago

Need to change permissions on the database folder for use. I will update shortly.

jvhagey commented 1 month ago

@kapsakcj ok, you had a good suggestion so I incorporated that and provided details in the readme. Hopefully, its clear.

kapsakcj commented 1 month ago

Thanks for making those changes! Will save users from doing an important step. And thank you for documenting that in the README 👍

The tool-specific README looks great, thank you for putting that together. I made few small changes to this readme as well as the main /README.md table

I tested with a handful of S flexneri, S sonnei, and S dysenteriae genomes and ShigaPass ran without issue and correctly predicted serotypes.

My only complaint is the....semi-colon....delimited output format, but that's not within the scope here

kapsakcj commented 1 month ago

Deploy workflow is here: https://github.com/StaPH-B/docker-builds/actions/runs/10712655108

The docker image should be available on dockerhub and quay.io shortly. Thank you!