nanite
A streamlined Oxford Nanopore Viral Metagenomics Pipeline
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 8 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.8%) to scientific vocabulary
Keywords
Repository
A streamlined Oxford Nanopore Viral Metagenomics Pipeline
Basic Info
- Host: GitHub
- Owner: OpenOmics
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://openomics.github.io/nanite
- Size: 627 KB
Statistics
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 1
- Releases: 3
Topics
Metadata Files
README.md
nanite 🔬
**_Viral Nanopore Pipeline_** [](https://doi.org/10.5281/zenodo.7477631) [](https://github.com/OpenOmics/nanite/releases) [](https://hub.docker.com/repository/docker/skchronicles/nanite)[](https://github.com/OpenOmics/nanite/actions/workflows/main.yaml) [](https://github.com/OpenOmics/nanite/actions/workflows/docs.yml) [](https://github.com/OpenOmics/nanite/issues) [](https://github.com/OpenOmics/nanite/blob/main/LICENSE) This is the home of the pipeline, nanite. Its long-term goals: to assemble, annotate, and screen nanopore samples like no pipeline before!
Overview
Welcome to nanite! Before getting started, we highly recommend reading through nanite's documentation.
The ./nanite pipeline is composed several inter-related sub commands to setup and run the pipeline across different systems. Each of the available sub commands perform different functions:
nanite run: Run the nanite pipeline with your input files.nanite unlock: Unlocks a previous runs output directory.nanite install: Download reference files locally.nanite cache: Cache software containers locally.
nanite is a streamlined viral metagenomics pipeline to assemble, annotate, and classify microorganisms in enviromental samples. It relies on technologies like Singularity1 to maintain the highest-level of reproducibility. The pipeline consists of a series of data processing and quality-control steps orchestrated by Snakemake2, a flexible and scalable workflow management system, to submit jobs to a cluster.
The pipeline is compatible with data generated from Nanopore sequencing technologies. As input, it accepts a set of FastQ files and can be run locally on a compute instance or on-premise using a cluster. A user can define the method or mode of execution. The pipeline can submit jobs to a cluster using a job scheduler like SLURM (more coming soon!). A hybrid approach ensures the pipeline is accessible to all users.
Before getting started, we highly recommend reading through the usage section of each available sub command.
For more information about issues or trouble-shooting a problem, please checkout our FAQ prior to opening an issue on Github.
Dependencies
Requires: singularity>=3.5 snakemake>=6.0 conda/mamba (optional)
Snakemake must be installed on the target system. Snakemake is a workflow manager that orchestrates each step of the pipeline. The second dependency, i.e singularity OR conda/mamba, handles the dowloading/installation of any remaining software dependencies. By default, the pipeline will utilize singularity to guarantee the highest level of reproducibility; however, the --use-conda option of the run sub command can be provided to use conda/mamba instead of singularity. If possible, we recommend using singularity over conda for reproducibility; however, it is worth noting that singularity and conda produce identical results for this pipeline.
If you are running the pipeline on Windows, please use the Windows Subsystem for Linux (WSL). Singularity can be installed on WSL following these instructions.
Installation
Please clone this repository to your local filesystem using the following command: ```bash
Clone Repository from Github
git clone https://github.com/OpenOmics/nanite.git
Change your working directory
cd nanite/
Add dependencies to $PATH
Biowulf users should run
module load snakemake singularity
Get usage information
./nanite -h ```
For more detailed installation instructions, please see our setup page.
Contribute
This site is a living document, created for and by members like you. nanite is maintained by the members of OpenOmics and is improved by continous feedback! We encourage you to contribute new content and make improvements to existing content via pull request to our GitHub repository.
Cite
If you use this software, please cite it as below:
@BibText
```text @software{Kuhn_OpenOmics_nanite_2022, author = {Skyler Kuhn and Paul Schaughency}, doi = {10.5281/zenodo.7477631}, title = {OpenOmics/nanite}, month = dec, year = 2022, url = {https://github.com/OpenOmics/nanite/} } ```@APA
```text Skyler Kuhn, & Paul Schaughency. (2022). OpenOmics/nanite [Computer software]. https://doi.org/10.5281/zenodo.7477631 ```For more citation style options, please visit the pipeline's Zenodo page.
References
1. Kurtzer GM, Sochat V, Bauer MW (2017). Singularity: Scientific containers for mobility of compute. PLoS ONE 12(5): e0177459.
2. Koster, J. and S. Rahmann (2018). "Snakemake-a scalable bioinformatics workflow engine." Bioinformatics 34(20): 3600.
Owner
- Name: OpenOmics
- Login: OpenOmics
- Kind: organization
- Location: United States of America
- Repositories: 9
- Profile: https://github.com/OpenOmics
Open Bioinformatics Research
Citation (CITATION.cff)
cff-version: 1.1.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Kuhn
given-names: Skyler
orcid: https://orcid.org/0000-0003-0606-2125
- family-names: Schaughency
given-names: Paul
orcid: https://orcid.org/0000-0002-3358-2102
title: OpenOmics/nanite
doi: 10.5281/zenodo.7477631
date-released: 2022-12-23
url: "https://github.com/OpenOmics/nanite/"
GitHub Events
Total
- Delete event: 2
- Push event: 14
- Create event: 5
Last Year
- Delete event: 2
- Push event: 14
- Create event: 5
Committers
Last synced: almost 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| skchronicles | k****3@g****m | 56 |
Issues and Pull Requests
Last synced: almost 2 years ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0