For the complete TOSTADAS documentation, please see the Wiki
T O S T A D A S
Toolkit for Open Sequence Triage, Annotation, and DAtabase Submission
A portable, open-source pipeline designed to streamline submission of pathogen genomic data to public repositories. Reducing barriers to timely data submission increases the value of public repositories for both public health decision making and scientific research. TOSTADAS facilitates routine sequence submission by standardizing and automating:
- Metadata Validation
- Genome Annotation
- File submission
TOSTADAS is designed to be flexible, modular, and pathogen agnostic, allowing users to customize their submission of raw read data, assembled genomes, or both. The current release has been tested with sequence data from Poxviruses and select bacteria. Testing for additional pathogen is planned for future releases.
β Note: If you are a CDC user, please follow the set-up instructions found here: CDC User Guide
For non-CDC users, please follow the instructions below.
git clone https://github.com/CDCgov/tostadas.git
! Note: If you already have Nextflow installed in your local environment, skip ahead to step 5.
2a. Install mamba
β Note: If you have mamba installed in your local environment, skip ahead to step 3 (Create and activate a conda environment)
curl -L -O https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-$(uname)-$(uname -m).sh
bash Mambaforge-$(uname)-$(uname -m).sh -b -p $HOME/mambaforge
2b. Add mamba to PATH:
export PATH="$HOME/mambaforge/bin:$PATH"
3a. Create an empty conda environment
conda create --name tostadas
This conda environment will be used to install Nextflow.
3b. Activate the environment
conda activate tostadas
Verify which environment is active by running the following conda command: conda env list
. The active environment will be denoted with an asterisk *
mamba install -c bioconda nextflow
5. Update the default submissions config file with your NCBI username and password, and run the following nextflow command to execute the scripts with default parameters and the local run environment:
# update this config file (you don't have to use vim)
vim bin/config_files/default_config.yaml
# test command for virus reads
nextflow run main.nf -profile test,<singularity|docker|conda> --virus
The pipeline outputs appear in tostadas/test_output
Annotate and submit viral reads
nextflow run main.nf -profile <docker|singularity> --species virus --submission --annotation --genbank true --sra true --biosample true --output_dir <path/to/output/dir/> --meta_path <path/to/metadata_file.xlsx> --submission_config <path/to/submission_config.yaml>
Annotate and submit bacterial reads
nextflow run main.nf -profile <docker|singularity> --species bacteria --submission --annotation --genbank true --sra true --biosample true --meta_path <path/to/metadata_file.xlsx> --submission_config <path/to/submission_config.yaml> --download_bakta_db --bakta_db_type <light|full> --output_dir <path/to/output/dir/>
Refer to the wiki for more information on input parameters and use cases
If you need to report a bug, suggest new features, or just say βthanksβ, open an issue and weβll try to get back to you as soon as possible!
Kyle O'Connell | Yesh Kulasekarapandian | Ankush Gupta | Cole Tindall | Jessica Rowell | Swarnali Louha | Michael Desch | Ethan Hetrick | Nick Johnson | Kristen Knipe | Shatavia Morrison | Yuanyuan Wang | Michael Weigand | Dhwani Batra | Jason Caravas | Lynsey Kovar | Hunter Seabolt | Crystal Gigante | Christina Hutson | Brent Jenkins | Yu Li | Ana Litvintseva | Matt Mauldin | Dakota Howard | Ben Rambo-Martin | James Heuser | Justin Lee | Mili Sheth
The submission portion of this pipeline was adapted from SeqSender. To find more information on this tool, please refer to their GitHub page: SeqSender
π NCBI Submission Guidelines: https://submit.ncbi.nlm.nih.gov/sarscov2/sra/#step6
π SeqSender Documentation: https://github.com/CDCgov/seqsender
π Liftoff Documentation: https://github.com/agshumate/Liftoff
π VADR Documentation: https://github.com/ncbi/vadr.git
π Bakta Documentation: https://github.com/oschwengers/bakta
π RepeatMasker Documentation: https://www.repeatmasker.org/