Authors: Rodshagen, Tyler; Tracy, Maxwell; Davidge, Brittney; Carnes, Jason; Morton, Glenn
Maintainer: Rodshagen, Tyler
Stuart Lab, Center for Global Infectious Disease
Research Scientific Computing
Seattle Childrens Research Institute
- Python (3.12+ with pandas, python-docx, biopython, xlsxwriter)
- R (4.4 with tidyverse)
- BBMap for BBMerge
- MUSCLE alignment software
You also need:
AmpliconsRawinput file (fasta)- R1 and R2 sequencing files
parers.cfg- a configuration file that informs the pipeline on how to run the sample(s)
It is recommended to use either of these as a template and modify for your samples:
Note: You may add as many pairs of R1, R2 sequences as you want as long as they are configured the same. i.e. Don't mix genes or primers.
Provided is parers.def which is an Apptainer definition file.
sudo apptainer build parers.sif parers.defOnce built, launch the container and ensure the directories mentioned in parers.cfg are in the bind paths for the container.
apptainer shell --bind /path/to/include parers.sifThe PARERS pipeline can be run by going to the directory with your parers.cfg and then running python3 /parers/parers.
cd /path/to/parers.cfg
python3 /parers/parersAlso provided is a parers.yml so you can create the parers conda or mamba environment from yml file
In order to set up the script to run in your environment, you need to tell it where somethings are:
bbmerge.shscriptmusclebinaryRscriptbinaryR_for_cmddirectory
Activate your parers conda environment that was created from the parers.yml in the step.
Now you will be able to use whereis to find the full path to bbmerge.sh script and each of the muscle and Rscript binaries.
whereis bbmerge.sh
whereis muscle
whereis RscriptYou also need to note the full path of the R_for_cmd directory.
You will need to edit the following variables in parers.py with the appropriate paths:
path_to_bbmerge = "/path/to/bbmerge.sh"
path_to_muscle = "/path/to/muscle"
path_to_r = "/path/to/Rscript"
path_to_r_scripts = "/path/to/R_for_cmd"The PARERS pipeline can be run by going to the directory with your parers.cfg and then running python3 /parers/parers.
cd /path/to/parers.cfg
python /path/to/parers.py