Flankophile-Sapelo2

From Research Computing Center Wiki
Revision as of 15:09, 6 March 2024 by Isaiah (talk | contribs) (Created Flankophile page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Category

Pipeline

Program On

Sapelo2

Version

0.2.10

Author / Distributor

Genomic Epidemiology

Description

"Flankophile is a bioinformatics pipeline for gene synteny analysis." Bitbucket

Running Program

Please also refer to Running Jobs on Sapelo2.

  • A module containing a pre-built Flankophile pipeline is available on Sapelo2.
    • module load Flankophile/0.2.10

Requirements

Flankophile requires the following:

  1. The Flankophile pipeline
    1. Contains the pipeline's files and all required conda environments.
  2. Input sequence data in FASTA (.fa) format
    1. One or more FASTA files that Flankophile should use as input.
  3. A tab-separated value (.tsv) metadata file
    1. Describes the assembly name, the filepath, and the genus for each input FASTA file.
  4. An analysis configuration file in YAML (.yaml)
    1. Describes the analysis for Flankophile to perform and the parameters to use during analysis.
    2. Should be located at the root of the Flankophile repository directory.

Setup

Before running Flankophile, the pipeline must be cloned and the dependencies must be installed. For convenience, a Flankophile directory has already been setup in a module that can be copied and used directly.

Pre-Built GACRC Setup

GACRC provides a complete Flankophile directory in a module.

To use it, load the module and copy the directory into your user's /scratch directory. It may take a while to copy the directory due to its size.

  1. module load Flankophile/0.2.10
  2. cp -r $EBROOTFLANKOPHILE/flankophile /scratch/$USER/

The Flankophile pipeline in this directory already contains all required conda environments, and is ready for use.

Manual Setup

The steps to manually setup Flankophile are as follows:

  1. Enter into an interactive session The installation of Flankophile involves an amount of resource utilization that should be performed by a compute node and not a submit node.
    1. interact --cpus-per-task 16 --mem 32GB
  2. Change the working directory to your user's /scratch directory Like other pipelines, the Flankophile installation directory should be in a location suited for large amounts of sustained I/O. Do not install Flankophile in the /home directory; the filesystem that hosts /home is not suited for this workload.
    1. cd /scratch/$USER
  3. Clone the Flankophile repository at the desired commit The versions of Flankophile are not labeled with tags in the project's Bitbucket page. Instead, the version is stated in the commit message; this guide will use the commit corresponding to version 0.2.10 (34f286e).
    1. git clone https://bitbucket.org/genomicepidemiology/flankophile/src/34f286e00088d12019dc30cb2c38c103f0efe506/ flankophile
      1. The ...0efe506/ flankophile at the end instructs git to clone the repository into the directory, flankophile.
  4. Change the working directory to the newly cloned flankophile/ repository
    1. cd flankophile
  5. Create the conda environments that Flankophile will use at runtime In some tests, creating the conda environments at runtime causes the pipeline to fail due to missing or incompatible dependencies. To avoid this, create the conda environments ahead of time. This step will take ~15-25 minutes to complete.
    1. snakemake --use-conda --conda-create-envs-only --cores 16

Example Files

As listed above, Flankophile requires input files, a metadata file, and a config file to run.

Note for Examples:
  • In each of the following examples, be sure to edit the files and replace all instances of $USER with your actual username.
Example Input Files

The example input files used were sourced from ResFinder's GitHub project page. For convenience, they can also be found in the directory, $EBROOTFLANKOPHILE/flankophile/example/data.

Assuming flankophile/ was copied into your user's /scratch directory, they are at the following paths:

  • /scratch/$USER/flankophile/example/data/test_isolate_01.fa
  • /scratch/$USER/flankophile/example/data/test_isolate_02.fa
  • /scratch/$USER/flankophile/example/data/test_isolate_03.fa
  • /scratch/$USER/flankophile/example/data/test_isolate_05.fa
  • /scratch/$USER/flankophile/example/data/test_isolate_09a.fa
  • /scratch/$USER/flankophile/example/data/test_isolate_09b.fa

The location for each of the above input files should be listed in the metadata file, shown next.

Example .tsv Metadata File

The following text is an example of a metadata file's contents:

#assembly_name	path	metadata
test_isolate_01	/scratch/$USER/flankophile/example/data/test_isolate_01.fa	Escherichia
test_isolate_02	/scratch/$USER/flankophile/example/data/test_isolate_02.fa	Escherichia
test_isolate_03	/scratch/$USER/flankophile/example/data/test_isolate_03.fa	Escherichia
test_isolate_05	/scratch/$USER/flankophile/example/data/test_isolate_05.fa	Escherichia
test_isolate_09a	/scratch/$USER/flankophile/example/data/test_isolate_09a.fa	Escherichia
test_isolate_09b	/scratch/$USER/flankophile/example/data/test_isolate_09b.fa	Escherichia

Assuming flankophile/ was copied into your user's /scratch directory, this metadata file is at the following path:

  • /scratch/$USER/flankophile/example/metadata.tsv

When using your own data, be sure to create a new metadata.tsv file that lists the paths to your input data instead of the example data.

The location of the metadata will be listed in the configuration file, shown next.

Example .yaml Configuration File

The following text is an example of a Flankophile configuration file's contents:

# FLANKOPHILE version 0.2.10
# Alix Vincent Thorn


## 1 #######################################################################################

database: "input/example_input_files/ResFinder_08_02_2022.fa"

input_list: "example/metadata.tsv"     # Edit this!

min_coverage_abricate: "98"                   # Minimum coverage in percentage compared to reference sequence.

min_identity_abricate: "98"                   # Minimum percentage identity compared to reference sequence.

## 2 ######################################################################################

flank_length_upstreams: "1500"

flank_length_downstreams: "1500"

## 3 #######################################################################################

cluster_identity_and_length_diff: "0.98"      # CD-HIT parameters = c and s.  0.98 = cluster at 98 % identity and a maximum length difference of 98 %

## 4  ######################################################################################

k-mer_size: "16"                              # Kmersize used by kma index. Try with "16" if in doubt.

distance_measure: "1"                         # Choose measurement for making distance matrix



# Distance calculation methods:
#
#        1      k-mer hamming distance
#       64      Jaccard distance
#      256      Cosine distance
#     4096      Chi-square distance

Assuming flankophile/ was copied into your user's /scratch directory, this metadata file is at the following path:

  • /scratch/$USER/flankophile/config.yaml

This configuration file contains the path to the metadata file, which contains the paths to the input data.

When using your own data, be sure to edit the config.yaml file to include the location of the corresponding metadata.tsv file you created for them.

Starting the Pipeline

Once the required files are in place, using either the above examples or your own inputs, the pipeline can be started in either an interactive session or within a job submission script.

In an Interactive Session

The procedure to start the Flankophile pipeline in an interactive session is as follows:

  1. Enter into an interactive session if not already inside one.
    1. interact --cpus-per-task 16 --mem 32GB
  2. Change the working directory to the location of the flankophile/ directory. (The following command assumes it is in the base of your /scratch directory)
    1. cd /scratch/$USER/flankophile/
  3. Load the snakemake module into your environment. (Flankophile requires snakemake 6.9.1 with Miniconda/Mamba 4.11.0)
    1. module load snakemake/6.9.1-Mamba-4.11.0-4
  4. Identify the name of the Conda environment to activate.
    1. ls .snakemake/conda/
  5. Activate the Conda environment that Flankophile will use.
    1. source activate /source/$USER/flankophile/.snakemake/conda/50e62e607e6a24bb70ce9a5a50888445
  6. Run the pipeline.
    1. snakemake --use-conda --cores 16
In a Job Submission Script

The following is an example of a job submission script that runs the Flankophile pipeline:

#!/bin/bash
#SBATCH --job-name=Flankophile
#SBATCH --partition=batch
#SBATCH --ntasks=1
#SBATCH --cpus-per-task=16
#SBATCH --mem=32gb
#SBATCH --time=01:00:00
#SBATCH --output=%x.%j.out
#SBATCH --error=%x.%j.err

module load snakemake/6.9.1-Mamba-4.11.0-4

# The following assumes flankophile/ was copied into the base of your user's /scratch 
cd /scratch/$USER/flankophile/
source activate /source/$USER/flankophile/.snakemake/conda/50e62e607e6a24bb70ce9a5a50888445

snakemake --use-conda --cores 16

Please note that you need to identify the correct name of the Conda environment just as you would if running the pipeline from within an interactive session.

Assuming flankophile/ was copied into your user's /scratch directory, use the following steps to identify the name of the Conda environment:

  1. Identify the name of the Conda environment to activate.
    1. ls /scratch/$USER/flankophile/.snakemake/conda/

Make sure to adjust the job submission script so that the correct Conda environment is loaded.

Installation

  • Version 0.2.10: Installed using EasyBuild.

System

  • 64-bit Linux
Retrieved from "https://wiki.gacrc.uga.edu/index.php?title=Flankophile-Sapelo2&oldid=21738"