phunky
Nanopore long read assembly data pipeline for phage genomes
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 4 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (9.7%) to scientific vocabulary
Keywords
Repository
Nanopore long read assembly data pipeline for phage genomes
Basic Info
- Host: GitHub
- Owner: JoshuaIszatt
- Language: Python
- Default Branch: master
- Homepage: https://pypi.org/project/phunky/
- Size: 151 KB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 2
Topics
Metadata Files
README.md
Phunky
Long read assembly for phages:
Figure 1: Rough phage assembly pipeline, dotted line indicates where processing begins.
Install dependencies
Download the yml environment file:
wget https://anaconda.org/JoshIszatt/phunky/2024.05.24.145220/download/phunky.ymlCreate the environment
conda env create --file phunky.ymlActivate the environment:
conda activate phunkyInstall phunky pipeline:
pip install phunkyOptional: Setup the checkv database
checkv download_database /path/to/checkv-db
export CHECKVDB=/path/to/checkv-db
Usage
Open a python terminal and enter:
py
import phunky
dir(phunky)
Quick phage assembly:
```py import phunky
phunky.assemblypipeline('examplereads.bam', 'output_directory/') ```
Batch phage assembly:
py
import phunky
phunky.batch_assembly_pipeline('reads_directory/', 'output_directory/')
Citation:
There is a CITATION file in this repository (.CFF), however Phunky may also be cited like so:
Iszatt, Joshua James. (2024). PHUNKY long read assembly pipeline (Version v0.3) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.13981020
Dependencies:
- python>=3
- checkv==1.0.3
- biopython==1.83
- bbmap==39.06
- pandas==2.2.1
- matplotlib==3.8.4
- flye==2.9.3
- porechop_abi==0.5.0
- nanoplot==1.42.0
- filtlong==0.2.1
General todo
- Create conda distribution
- Add hash key function
Owner
- Name: Joshua Iszatt
- Login: JoshuaIszatt
- Kind: user
- Location: Perth
- Twitter: JoshuaIszatt
- Repositories: 1
- Profile: https://github.com/JoshuaIszatt
PhD candidate. Interested in microbial genomics and protein structures. https://www.researchgate.net/profile/Joshua-Iszatt
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Iszatt"
given-names: "Joshua James"
orcid: "https://orcid.org/0000-0002-6394-5058"
title: "PHUNKY long read assembly pipeline"
version: "v0.3"
identifiers:
- type: doi
value: 10.5281/zenodo.13981020
url: "https://github.com/JoshuaIszatt/phunky"
date-released: 2024-06-20
GitHub Events
Total
- Release event: 1
- Push event: 2
- Create event: 2
Last Year
- Release event: 1
- Push event: 2
- Create event: 2