diffmethseq

A NextFlow pipeline to perform differential methylation analysis from bismark-aligned files

https://github.com/jd2112/diffmethseq

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.3%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

A NextFlow pipeline to perform differential methylation analysis from bismark-aligned files

Basic Info
  • Host: GitHub
  • Owner: JD2112
  • License: mit
  • Language: R
  • Default Branch: main
  • Size: 42 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created about 1 year ago · Last pushed about 1 year ago
Metadata Files
Readme License Code of conduct Citation Codeowners Security Support

README.md

DiffMethSeq

A NextFlow pipeline to perform differential methylation analysis from bismark-aligned files

NOTE: UNDER DEVELOPMENT

Description

Workflow

Pipeline DAG

Running environment

Please update the selected environment in the nextflow.config file.

Using Conda

Conda can be used to run the pipeline. [update with yaml file- working]

Using Docker

Build the docker image using the Dockerfile. Default in nextflow.config will use jd21/r-nf:240129.

cd env docker build -t <USERNAME>/<tags> .

Using Singularity/Apptainer

Docker image can be directly used in the Singularity/Apptainer (no need to build an apptainer image for now). User can use the same docker image jd21/r-nf:240129 pull using the apptainer by changing the nextflow.config.

Input files and paths

  1. formatted_designfile (required): (.tsv) with columns, 'Sample_ID', 'input_R1', 'input_R2', 'ip_R1', 'ip_R2', 'Group_ID' \
  2. compare_string (required): 'treatedvscontrol' (or whatever group you have to compare)\
  3. cov_dir (required for edgeR analysis): Path to the directory of bismark-generated zipped coverage files (deduplicated and sorted, if required). \
  4. bam_dir (required for MethylKit analysis): Path to the directory of bismark-generated bam files. \
  5. phenoGroup (required for MethylKit analysis): to know the group information, e.g. if you have 6 samples, like 'control', 'patient', 'control', 'patient', 'control', 'patient', then the file needs a line like this - c(0,1,0,1,0,1,0,1).

NOTE: It is possible to run either EdgeR or MethylKit.

How to run

  1. Load Nextflow module: ml nextflow-23.10.1
  2. docker installation required
  3. Load Singularity module: ml singularity-3.8.3

```

differential methylation analysis

nextflow run main.nf -profile docker \ --formatteddesignfile ./data/Samplesheet.csv \ --comparestr ./data/comparefile.txt \ --covdir data/ \ --bamdir /bismark/deduplicated/sortedbam/ \ --phenoGroup ./data/treatment.txt ```

Results

The pipeline will generates three directories - edgeR - MethylKit - pipeline_info

Results demo

Credits

  • Main Author:

  • Collaborators:

Citation

Das, J. (2025). DiffMethSeq (v1.0.0). Zenodo. https://doi.org/10.5281/zenodo.14762150

HELP/FAQ/Troubleshooting

Please create issues on github.

Acknowledgement

We would like to acknowledge the Core Facility, Faculty of Medicine and Health Sciences, Linköping University, Linköping, Sweden and Clinical Genomics Linköping, Science for Life Laboratory, Sweden for their support.

Owner

  • Name: Jyotirmoy Das
  • Login: JD2112
  • Kind: user
  • Location: Linköping, Sweden
  • Company: Linköping University

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Das
    given-names: Jyotirmoy
    orcid: https://orcid.org/0000-0002-5649-4658
title: "DiffMethSeq"
version: 1.0.0
identifiers:
  - type: doi
    value: 10.5281/zenodo.14762150
date-released: 2025-01-29

GitHub Events

Total
  • Release event: 1
  • Push event: 2
  • Create event: 3
Last Year
  • Release event: 1
  • Push event: 2
  • Create event: 3

Dependencies

env/Dockerfile docker
  • jd21/nano-dnam latest build