Skip to content

metagenlab/assembly_finder

Repository files navigation

assembly_finder

tests docs docker

snaketool license version downloads

DOI

assembly_finder is a Snakemake-powered cli, written in Snaketool, to download genomes with NCBI datasets.

⚡ Quick start

Installation

conda create -n assembly_finder assembly_finder

Note

Miniforge is the recommended conda-based distribution

apptainer pull docker://ghcr.io/metagenlab/assembly_finder:latest

Usage

Conda

assembly_finder -i staphylococcus_aureus -nb 1

Apptainer

apptainer run docker://ghcr.io/metagenlab/assembly_finder:latest \
assembly_finder -i staphylococcus_aureus -nb 1 --no-use-conda

Note

set --no-use-conda when running in a container

Output

📂staphylococcus_aureus
 ┣ 📂download
 ┃ ┣ 📂GCF_000013425.1
 ┃ ┃ ┗ 📜GCF_000013425.1_ASM1342v1_genomic.fna.gz
 ┃ ┗ 📜.snakemake_timestamp
 ┣ 📂logs
 ┃ ┣ 📂taxons
 ┃ ┃ ┗ 📜staphylococcus_aureus.log
 ┃ ┣ 📜archive.log
 ┃ ┣ 📜lineage.log
 ┃ ┣ 📜rsync.log
 ┃ ┗ 📜unzip.log
 ┣ 📜archive.zip
 ┣ 📜assembly_finder.log
 ┣ 📜assembly_summary.tsv
 ┣ 📜config.yaml
 ┣ 📜sequence_report.tsv
 ┗ 📜taxonomy.tsv

📚 Documentation

You can find more information on assembly_finder's inputs, outputs and example commands in the documentation

📜 Help

assembly_finder -h