Snakemake implementation of the Isoseq3.3 pipeline
Version 1

Workflow Type: Snakemake
Stable

Snakemake workflow: Isoseq3.3

Snakemake

This workflow implements the PacBio Isoseq v3.3.0 pipeline.

Note: Currently this workflow is limited to non-multiplexed samples.

Authors

  • Terry Bertozzi

Usage

If you use this workflow in a paper, don't forget to cite the URL of this (original) repository and, if available, its DOI (see above).

Step 1: Obtain a copy of this workflow

  1. Create a new github repository using this workflow as a template.
  2. Clone the newly created repository to your local system, into the place where you want to perform the data analysis.

Step 2: Configure workflow

General settings

Configure the workflow according to your needs by editing the config.yaml file in the config/ folder.

Sample sheet

  • Add samples to the tab delimited file config/samples.tsv.
  • For each sample, add one or more sequencing units (isoseq flow cells) and the paths to the BAM files. Data should be placed into the data folder. Note: An example samples.tsv is provided which references test data in the data directory.

Primer file

The workflow requires a fasta formatted primer file for primer removal. Primers must be named according to this document. The primer file should be placed into the resources/ folder.

Step 3: Install singularity

This workflow uses singularity containers to run the various parts of the Isoseq3 pipeline and maintain version control. If singularity is not installed on your system, you can install it by following the instructions here

Step 4: Install Snakemake

Install Snakemake using conda:

conda create -c bioconda -c conda-forge -n snakemake snakemake

For installation details, see the instructions in the Snakemake documentation.

Step 5: Execute workflow

The workflow must be run from the top directory

 cd isoseq3.3

Activate the conda environment:

conda activate snakemake

Test your configuration by performing a dry-run via

snakemake --use-singularity -n

Execute the workflow locally using $N cores via

snakemake --use-singularity --cores $N

See the Snakemake documentation for further details about running the workflow on a cluster.

Step 6: Investigate results

After successful execution, you can create a self-contained interactive HTML report with all results via:

snakemake --report report.html

An example (using some trivial test data) can be seen here.

Version History

master @ 541c01d (earliest) Created 21st Mar 2023 at 05:33 by Terry Bertozzi

updated README


Frozen master 541c01d
help Creators and Submitter
Creator
Submitter
License
Activity

Views: 431

Created: 21st Mar 2023 at 05:33

help Tags
help Attributions

None

Total size: 1.39 GB
Powered by
(v.1.15.0-pre)
Copyright © 2008 - 2024 The University of Manchester and HITS gGmbH