Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 2.59 KB

README.md

File metadata and controls

54 lines (39 loc) · 2.59 KB
Raw

2023-amblyomma-americanum-txome-assembly

This repository contains the code we used in the pub, "Predicted genes from the Amblyomma americanum draft genome assembly." The main outputs of this workflow are available on zenodo.

Getting started with this repository

Running the pipeline on an AWS EC2 instance

We used the Canonical, Ubuntu, 22.04 LTS, amd64 jammy image build on 2023-05-16 with 64 bit architecture and AMI ID ami-0f8e81a3da6e2510a. We initially launched an m5a.large instance, and after configuration ran the pipeline on m5a.2xlarge instance type. To set up the instance to run the pipeline, we installed and configured miniconda with the commands below.

curl -JLO https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh # download the miniconda installation script
bash Miniconda3-latest-Linux-x86_64.sh # run the miniconda installation script. Accept the license and follow the defaults.
source ~/.bashrc # source the .bashrc for miniconda to be available in the environment

# configure miniconda channel order
conda config --add channels defaults 
conda config --add channels bioconda
conda config --add channels conda-forge
conda config --set channel_priority strict
conda install mamba # install mamba for faster software installation.

Running the snakemake pipeline

This repository uses snakemake to run the pipeline and conda to manage software environments and installations. You can find operating system-specific instructions for installing miniconda here (see above for linux). After installing conda and mamba, run the following command to create the pipeline run environment. We installaed Miniconda3 version py311_23.5.2-0 and mamba version 1.4.9.

mamba env create -n amam --file environment.yml
conda activate amam

To start the pipeline, run:

snakemake --use-conda -j 2

The pipeline processes accessions listed in a TSV file, which defaults to inputs/metadata.tsv. To use a different set of accessions, override Snakemake's metadata_file configuration parameter; for example, to run on a smaller set of accessions listed in inputs/metadata_sample.tsv, use:

snakemake --use-conda -j 2 --config metadata_file=inputs/metadata_sample.tsv

Contributing

See this guide to see how we recognize feedback and contributions on our code.