A snakemake utility for metagenomic sequencing analysis
Project description
Sunbeam: a robust, extensible metagenomic sequencing pipeline
Sunbeam is a pipeline written in snakemake that simplifies and automates many of the steps in metagenomic sequencing analysis. It can be installed through PyPi (pip), Bioconda (conda), DockerHub (docker), or GitHub (git). Sunbeam was designed to be modular and extensible, allowing anyone to build off the core functionality. To read more, check out our paper in Microbiome.
Sunbeam currently automates the following tasks:
- Quality control, including adapter trimming, host read removal, and quality filtering;
- Taxonomic assignment of reads to databases using Kraken (sbx_kraken);
- Assembly of reads into contigs using Megahit (sbx_assembly);
- Contig annotation using BLAST[n/p/x] and Diamond (sbx_assembly);
- Mapping to reference genomes (sbx_mapping)
- ORF prediction using Prodigal (sbx_assembly).
More extensions can be found at https://github.com/sunbeam-labs.
To get started, see our documentation!
If you use the Sunbeam pipeline in your research, please cite:
EL Clarke, LJ Taylor, C Zhao, A Connell, J Lee, FD Bushman, K Bittinger. Sunbeam: an extensible pipeline for analyzing metagenomic sequencing experiments. Microbiome 7:46 (2019)
See how people are using Sunbeam:
- Shi, Z et al. Segmented Filamentous Bacteria Prevent and Cure Rotavirus Infection. Cell 179, 644-658.e13 (2019).
- Abbas, AA et al. Redondoviridae, a Family of Small, Circular DNA Viruses of the Human Oro-Respiratory Tract Associated with Periodontitis and Critical Illness. Cell Host Microbe 25, 719–729 (2019).
- Leiby, JS et al. Lack of detection of a human placenta microbiome in samples from preterm and term deliveries. Microbiome 6, 1–11 (2018).
Contributors
- Erik Clarke (@eclarke)
- Chunyu Zhao (@zhaoc1)
- Jesse Connell (@ressy)
- Louis Taylor (@louiejtaylor)
- Charlie Bushman (@ulthran)
- Kyle Bittinger (@kylebittinger)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sunbeamlib-5.0.4.tar.gz.
File metadata
- Download URL: sunbeamlib-5.0.4.tar.gz
- Upload date:
- Size: 25.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e4e65f5c1a22d714e4c020e2f1eb7bb5a55692ac57df51fbbfc1eae381dd0be1
|
|
| MD5 |
5e255e82bcc20f73511685f53871b926
|
|
| BLAKE2b-256 |
600464abc2010cb294fffef18f7b69a2244b9c0153b625dd60c59147e55827ec
|
Provenance
The following attestation bundles were made for sunbeamlib-5.0.4.tar.gz:
Publisher:
publish.yml on sunbeam-labs/sunbeam
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sunbeamlib-5.0.4.tar.gz -
Subject digest:
e4e65f5c1a22d714e4c020e2f1eb7bb5a55692ac57df51fbbfc1eae381dd0be1 - Sigstore transparency entry: 226070480
- Sigstore integration time:
-
Permalink:
sunbeam-labs/sunbeam@4562060bc6ccc20465cfa627fb4eb0127dcfdcba -
Branch / Tag:
refs/tags/v5.0.4 - Owner: https://github.com/sunbeam-labs
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@4562060bc6ccc20465cfa627fb4eb0127dcfdcba -
Trigger Event:
release
-
Statement type:
File details
Details for the file sunbeamlib-5.0.4-py3-none-any.whl.
File metadata
- Download URL: sunbeamlib-5.0.4-py3-none-any.whl
- Upload date:
- Size: 35.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5c8d1ec01423ea3e123fbcb50d34f067bdd810fea427c600283631acad15f894
|
|
| MD5 |
724e2cdc5f228772dd22f455c85bdc1c
|
|
| BLAKE2b-256 |
ecea6d6cef65a2f28ff4e474a3c65695726ebccc52f00ec98476de2047fb0e5c
|
Provenance
The following attestation bundles were made for sunbeamlib-5.0.4-py3-none-any.whl:
Publisher:
publish.yml on sunbeam-labs/sunbeam
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sunbeamlib-5.0.4-py3-none-any.whl -
Subject digest:
5c8d1ec01423ea3e123fbcb50d34f067bdd810fea427c600283631acad15f894 - Sigstore transparency entry: 226070481
- Sigstore integration time:
-
Permalink:
sunbeam-labs/sunbeam@4562060bc6ccc20465cfa627fb4eb0127dcfdcba -
Branch / Tag:
refs/tags/v5.0.4 - Owner: https://github.com/sunbeam-labs
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@4562060bc6ccc20465cfa627fb4eb0127dcfdcba -
Trigger Event:
release
-
Statement type: