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 5 DOI reference(s) in README -
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.0%) to scientific vocabulary
Repository
Measuring skewed X inactivation with long-read sequencing
Basic Info
- Host: GitHub
- Owner: QGouil
- License: mit
- Language: Nextflow
- Default Branch: master
- Size: 63.6 MB
Statistics
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 2
- Releases: 2
Metadata Files
README.md
SkewX
Introduction
SkewX is a nextflow pipeline to measure skewed X inactivation from long-read sequencing of native DNA, either with Pacbio or Nanopore or technologies. It starts from bam files that include modified basecalls for 5mCG. It first calls heterozygous variants with DeepVariant and phases them into haplotypes with WhatsHap. Then it also clusters reads based on their methylation profile over CpG islands, and pools this haplotype and epiallele information to measure the skew in X inactivation.
The pipeline is built using Nextflow, a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It uses Docker/Singularity containers making installation trivial and results highly reproducible. The Nextflow DSL2 implementation of this pipeline uses one container per process which makes it much easier to maintain and update software dependencies. Where possible, these processes have been submitted to and installed from nf-core/modules in order to make them available to all nf-core pipelines, and to everyone within the Nextflow community!
Pipeline summary
The required input is modbam files with 5mCG information.Then:
- If the reads are not already aligned, align to the reference genome with 'Minimap2'
- If multiple samples per individual are present, for instance multiple tissues, merge them into a single bam file
- Call variants with 'DeepVariant'
- Phase SNPs with 'WhatsHap'
- Haplotype and tag reads with 'WhatsHap'
- Cluster reads based on methylation profile with 'NanoMethViz'
- Measure skew in X inactivation and generate a report for each individual.
Quick Start
Install or module load
Nextflow(>=21.10.3)Install any of
Docker,Singularity(you can follow this tutorial),Podman,ShifterorCharliecloudfor full pipeline reproducibility (you can useCondaboth to install Nextflow itself and also to manage software within pipelines. Please only use it within pipelines as a last resort; see docs).IMPORTANT - ensure you mount singularity to your home directory (include "export NXFSINGULARITYHOME_MOUNT=true" in your .bashrc or to your session environment before launching pipeline - by default Singularity will not be able to find your home)
Ensure required files (.bed files, .fa reference) are properly specified as parameters in the config (nextflow.config)
Start running your own analysis!
bash
nextflow main.nf --input samplesheet.csv --outdir skew_results --reference chm13v2.0.fa --cgi_bedfile additional_files/CGIs_CHM13v2.0_chrX.bed -profile singularity
Documentation
Example data
An example dataset is available in the test_data directory of this repository. The dataset contains a small region of the mouse X chromosome, with a BAM file with methylation information. The pipeline can be run on this dataset with the following command:
bash
nextflow main.nf --input test_data/test_data_samplesheet.csv --outdir skew_test_results --reference test_data/mm10_chrX.fa --cgi_bedfile additional_files/CGIs_mm38_chrX.bed -profile test
Credits
SkewX was originally written by Quentin Gouil, James Lancaster and Ed Yang.
We thank the following people for their extensive assistance in the development of this pipeline:
- Kathleen Zeglinski for her superior nextflow expertise
- Shian Su for implementing new features in NanoMethViz
Citations
If you use SkewX for your analysis, please cite it using the following doi: 10.1101/gr.279396.124
An extensive list of references for the tools used by the pipeline can be found in the CITATIONS.md file.
Owner
- Name: Quentin Gouil
- Login: QGouil
- Kind: user
- Company: WEHI
- Twitter: QGouil
- Repositories: 2
- Profile: https://github.com/QGouil
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use `nf-core tools` in your work, please cite the `nf-core` publication"
authors:
- family-names: Ewels
given-names: Philip
- family-names: Peltzer
given-names: Alexander
- family-names: Fillinger
given-names: Sven
- family-names: Patel
given-names: Harshil
- family-names: Alneberg
given-names: Johannes
- family-names: Wilm
given-names: Andreas
- family-names: Garcia
given-names: Maxime Ulysse
- family-names: Di Tommaso
given-names: Paolo
- family-names: Nahnsen
given-names: Sven
title: "The nf-core framework for community-curated bioinformatics pipelines."
version: 2.4.1
doi: 10.1038/s41587-020-0439-x
date-released: 2022-05-16
url: https://github.com/nf-core/tools
prefered-citation:
type: article
authors:
- family-names: Ewels
given-names: Philip
- family-names: Peltzer
given-names: Alexander
- family-names: Fillinger
given-names: Sven
- family-names: Patel
given-names: Harshil
- family-names: Alneberg
given-names: Johannes
- family-names: Wilm
given-names: Andreas
- family-names: Garcia
given-names: Maxime Ulysse
- family-names: Di Tommaso
given-names: Paolo
- family-names: Nahnsen
given-names: Sven
doi: 10.1038/s41587-020-0439-x
journal: nature biotechnology
start: 276
end: 278
title: "The nf-core framework for community-curated bioinformatics pipelines."
issue: 3
volume: 38
year: 2020
url: https://dx.doi.org/10.1038/s41587-020-0439-x
GitHub Events
Total
- Issues event: 3
- Watch event: 2
- Issue comment event: 2
- Push event: 11
- Fork event: 1
- Create event: 1
Last Year
- Issues event: 3
- Watch event: 2
- Issue comment event: 2
- Push event: 11
- Fork event: 1
- Create event: 1
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 2
- Total pull requests: 0
- Average time to close issues: 3 months
- Average time to close pull requests: N/A
- Total issue authors: 1
- Total pull request authors: 0
- Average comments per issue: 0.5
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 2
- Pull requests: 0
- Average time to close issues: 3 months
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 0
- Average comments per issue: 0.5
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- PierreLaville (2)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/upload-artifact v3 composite
- nf-core/tower-action v3 composite
- actions/upload-artifact v3 composite
- nf-core/tower-action v3 composite
- mshick/add-pr-comment v1 composite
- actions/checkout v2 composite
- nf-core/setup-nextflow v1 composite
- actions/checkout v3 composite
- actions/setup-node v2 composite
- actions/checkout v2 composite
- actions/setup-node v2 composite
- actions/setup-python v3 composite
- actions/upload-artifact v2 composite
- mshick/add-pr-comment v1 composite
- nf-core/setup-nextflow v1 composite
- psf/black stable composite
- dawidd6/action-download-artifact v2 composite
- marocchino/sticky-pull-request-comment v2 composite