Clair3

Syumphonizing pileup and full-alignment for high-performance long-read variant calling.

Clair3 Homepage

Available Modules

Mahuika

module load Clair3/1.0.5-Miniconda3

Description

Clair3 homepage

Clair3 is a germline small variant caller for long-reads. Clair3 makes the best of two major method categories: pileup calling handles most variant candidates with speed, and full-alignment tackles complicated candidates to maximize precision and recall. Clair3 runs fast and has superior performance, especially at lower coverage. Clair3 is simple and modular for easy deployment and integration.

Clair3 is the 3^rd generation of Clair (the 2^nd) and Clairvoyante (the 1^st).

A short pre-print describing Clair3's algorithms and results is at bioRxiv.

License and Disclaimer

Copyright 2021 The University of Hong Kong, Department of Computer Science

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Re-distributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Re-distributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

Example Slurm script

Warning

Absolute path is needed for both INPUT_DIR and OUTPUT_DIR

#!/bin/bash -e

#SBATCH --account       nesi12345
#SBATCH --job-name      cliar3_job
#SBATCH --mem           6G #12G is just a place holder. Adjust accordingly
#SBATCH --cpus-per-task 4 #4 just a place holder. Adjust accordingly
#SBATCH --time          01:00:00
#SBATCH --output        slurmout.%j.out


#Caution: Absolute path is needed for both INPUT_DIR and OUTPUT_DIR

INPUT_DIR=/path/to/input/data         # e.g. /nesi/nobackup/nesi12345/input (absolute path needed)
OUTPUT_DIR=/path/to/save/outputs      # /nesi/nobackup/nesi12345/output (absolute path needed)
REF=/path/to/reference/genomes        # use the suggested Slurm variable which will read the value from `--cpus-per-task`
MODEL_NAME=/model/name                # e.g. r941_prom_hac_g360+g422


module purge
module load Clair3/0.1.12-Miniconda3

run_clair3.sh \
--bam_fn=${INPUT_DIR} \
--ref_fn=${REF} \
--threads=$SLURM_CPUS_PER_TASK \
--platform=ont \
--model_path=${CONDA_PREFIX}/bin/models/${MODEL_NAME} \
--output=${OUTPUT_DIR} --enable_phasing