snakemake-workflows/cyrcular-calling

A Snakemake workflow for ecDNA detection in Nanopore or Illumina sequencing reads derived from DNA samples enriched for circular DNA.

Overview

Latest release: v2.1.1, Last update: 2024-10-30

Linting: linting: passed, Formatting: formatting: failed

Deployment

Step 1: Install Snakemake and Snakedeploy

Snakemake and Snakedeploy are best installed via the Conda. It is recommended to install conda via Miniforge. Run

conda create -c conda-forge -c bioconda -c nodefaults --name snakemake snakemake snakedeploy

to install both Snakemake and Snakedeploy in an isolated environment. For all following commands ensure that this environment is activated via

conda activate snakemake

For other installation methods, refer to the Snakemake and Snakedeploy documentation.

Step 2: Deploy workflow

With Snakemake and Snakedeploy installed, the workflow can be deployed as follows. First, create an appropriate project working directory on your system and enter it:

mkdir -p path/to/project-workdir
cd path/to/project-workdir

In all following steps, we will assume that you are inside of that directory. Then run

snakedeploy deploy-workflow https://github.com/snakemake-workflows/cyrcular-calling . --tag v2.1.1

Snakedeploy will create two folders, workflow and config. The former contains the deployment of the chosen workflow as a Snakemake module, the latter contains configuration files which will be modified in the next step in order to configure the workflow to your needs.

Step 3: Configure workflow

To configure the workflow, adapt config/config.yml to your needs following the instructions below.

Step 4: Run workflow

The deployment method is controlled using the --software-deployment-method (short --sdm) argument.

To run the workflow with automatic deployment of all required software via conda/mamba, use

snakemake --cores all --sdm conda

Snakemake will automatically detect the main Snakefile in the workflow subfolder and execute the workflow module that has been defined by the deployment in step 2.

For further options such as cluster and cloud execution, see the docs.

Step 5: Generate report

After finalizing your data analysis, you can automatically generate an interactive visual HTML report for inspection of results together with parameters and code inside of the browser using

snakemake --report report.zip

Configuration

The following section is imported from the workflow’s config/README.md.

General settings

To configure this workflow, modify config/config.yaml according to your needs, following the explanations provided in the file.

Sample sheet

Add samples to config/samples.tsv. For each sample, the columns sample_name, platform, and group have to be defined.

  • Samples within the same group will be called jointly.
  • The platform column needs to contain the used sequencing plaform ('illumina','nanopore'). Note that Illumina data is supplementary, i.e. circles will only be called for sample groups that have at at least 'nanopore' as their platform.

Missing values can be specified by empty columns or by writing NA. Lines can be commented out with #.

Unit sheet

For each sample, add one or more sequencing units (runs, lanes or replicates) to the unit sheet config/units.tsv.

  • Each unit has a unit name, which can be e.g. a running number, or an actual run, lane or replicate id.
  • Each unit has a sample name, which associates it with the biological sample it comes from.
  • For each unit, define either one (column fq1) or two (columns fq1, fq2) FASTQ files (these can point to anywhere in your system).
  • Alternatively, you can define an SRA (sequence read archive) accession (starting with e.g. ERR or SRR) by using a column sra. In the latter case, the pipeline will automatically download the corresponding paired end reads from SRA. If both local files and SRA accession are available, the local files will be preferred.

Missing values can be specified by empty columns or by writing NA. Lines can be commented out with #.

Linting and formatting

Linting results

All tests passed!

Formatting results

 1[DEBUG] 
 2[DEBUG] 
 3[DEBUG] 
 4[DEBUG] 
 5[DEBUG] 
 6[DEBUG] 
 7[DEBUG] 
 8[DEBUG] 
 9[DEBUG] In file "/tmp/tmpoj89lkkd/snakemake-workflows-cyrcular-calling-61b6005/workflow/rules/map.smk":  Formatted content is different from original
10[DEBUG] 
11[INFO] 1 file(s) would be changed 😬
12[INFO] 8 file(s) would be left unchanged 🎉
13
14snakefmt version: 0.10.2