https://github.com/wernerkrampl/septool
Integrated tool for sepsis analysis
https://github.com/wernerkrampl/septool
Last synced: 3 months ago
JSON representation
Integrated tool for sepsis analysis
- Host: GitHub
- URL: https://github.com/wernerkrampl/septool
- Owner: wernerkrampl
- License: gpl-2.0
- Created: 2024-12-30T20:30:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-30T21:02:24.000Z (over 1 year ago)
- Last Synced: 2025-01-07T19:39:24.450Z (over 1 year ago)
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# septool
Integrated automatic tool for sepsis analysis.
This repository contains an automatic integrated software Septool - a snakemake pipeline for analyzing Nanopore FASTQ files for presence of microbial sources of sepsis.
## Prerequisites
1. Ubuntu 24.04 or higher (other Linux distros should work, although they were not tested)
2. Conda and Mamba installed
3. Git
## Installation
1. Clone the repository:
```
git clone https://github.com/wernerkrampl/septool.git
cd septool
```
2. Create conda environment:
```
mamba create septool-env snakemake
mamba activate septool-env
```
## Usage
1. Prepare input files:
- Place your FASTQ files in the repository root directory
- Ensure you have a reference genome named reference.fasta, which contains reference sequences for microbiome of interest (note that Septool will check several databases, this reference is used predominantly for validation of Septool findings)
2. Run the Septool pipeline
```
snakemake --cores --use-conda
```
## Output
- Reports and processed files will be generated in the following directories:
- `reports/fastqc`: Quality control reports
- `processed`: Trimmed and mapped files
- `reports/kraken2`: Taxonomic classification reports
- `reports/resfinder`: Resistance gene detection reports
- `reports/amrfinder`: Antimicrobial resistance analysis reports
- `reports/qualimap`: Mapping quality reports