-
Notifications
You must be signed in to change notification settings - Fork 119
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
adding krakentools version d4a2fbe (#1079)
* add genoflu * add readme * add to license * add --force-pkgs-dirs * krakentools add * update readmes * silence warnings about AS casing; fix typo * added comment in dockerfile & added additional dependencies and versions to readme for krakentools * pinning biopython and pandas versions and removing unnecessary jq and gawk * fixed version of python installed listed in krakentools readme --------- Co-authored-by: Curtis Kapsak <[email protected]>
- Loading branch information
1 parent
0dbaea4
commit 1610fdf
Showing
4 changed files
with
79 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
FROM ubuntu:jammy AS app | ||
|
||
WORKDIR / | ||
|
||
# using a git commit because the last release was over three years ago, despite recent(ish) activity in the repo's main branch | ||
# this commit is from 2023-11-16: https://github.com/jenniferlu717/KrakenTools/commit/d4a2fbe2833c2392a724697c0c97a3014e748474 | ||
ARG KRAKENTOOLS_VERSION="d4a2fbe2833c2392a724697c0c97a3014e748474" | ||
|
||
# LABEL instructions tag the image with metadata that might be important to the user | ||
LABEL base.image="ubuntu:jammy" | ||
LABEL dockerfile.version="1" | ||
LABEL software="KrakenTools" | ||
LABEL software.version=${KRAKENTOOLS_VERSION} | ||
LABEL description="KrakenTools is a set of tools for processing Kraken output" | ||
LABEL website="https://github.com/jenniferlu717/KrakenTools" | ||
LABEL documentation="https://github.com/jenniferlu717/KrakenTools" | ||
LABEL license="https://github.com/jenniferlu717/KrakenTools/blob/master/LICENSE" | ||
LABEL maintainer="Sage Wright" | ||
LABEL maintainer.email="[email protected]" | ||
|
||
|
||
# Install dependencies via apt-get; cleanup apt garbage | ||
RUN apt-get update && apt-get install -y --no-install-recommends \ | ||
wget \ | ||
ca-certificates \ | ||
python3 \ | ||
python3-pip \ | ||
python3-setuptools \ | ||
git \ | ||
procps && \ | ||
apt-get autoclean && rm -rf /var/lib/apt/lists/* | ||
|
||
RUN pip install biopython==1.84 \ | ||
pandas==2.2.3 | ||
|
||
RUN git clone https://github.com/jenniferlu717/KrakenTools.git && \ | ||
cd KrakenTools && \ | ||
git checkout ${KRAKENTOOLS_VERSION} && \ | ||
chmod +x * | ||
|
||
ENV PATH=/KrakenTools:${PATH} | ||
|
||
WORKDIR /data | ||
|
||
FROM app AS test | ||
|
||
RUN python3 /KrakenTools/extract_kraken_reads.py --help |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# KrakenTools container | ||
|
||
Main tool [KrakenTools](https://github.com/jenniferlu717/KrakenTools) | ||
|
||
Code repository: https://github.com/jenniferlu717/KrakenTools | ||
|
||
Additional tools: | ||
|
||
- python 3.10.12 | ||
- biopython 1.84 | ||
- pandas 2.2.3 | ||
- numpy 2.1.2 | ||
|
||
Basic information on how to use this tool: | ||
|
||
- executable: various python scripts | ||
- help: most scripts have -h options | ||
- version: most scripts do not have versioning information | ||
- description: "KrakenTools is a suite of scripts to be used alongside the Kraken, KrakenUniq, Kraken 2, or Bracken programs. These scripts are designed to help Kraken users with downstream analysis of Kraken results." | ||
|
||
Additional information: | ||
|
||
Full documentation: [https://github.com/jenniferlu717/KrakenTools](https://github.com/jenniferlu717/KrakenTools) | ||
|
||
## Example Usage | ||
|
||
```bash | ||
python3 /KrakenTools/extract_kraken_reads.py -h | ||
``` |