Giter Club home page Giter Club logo

peals's Introduction

PEALS: Peak-based Enhancement Analysis PipeLine for MeRIP-Seq

Latest Release:

  • Github: Github Release
  • PyPI: PyPI Release PyPI Python Version PyPI Format

Introduction

MeRIP-seq stands for methylated RNA immunoprecipitation sequencing, which is the most popular method for detection of post-transcriptional RNA modifications. Here, we presented the P-based Enhancement Analysis PipeLine for MeRIP-Seq (PEALS), for identifying enriched methylation regions. PEALS is designed for capturing the enriched methylated regions from MeRIP-seq, where IP signals are significantly over the input signals. Unlike other tools, PEALS not only can detect the peaks located across the exons, but also can detect peaks located in introns. It will be very usefull to detect the methylated peaks in caRNAs, primary transcripts, etc. After peak detections, PEALS wrap DESeq2 framework to estimate the enrichment and their significance. When detecting the differentially methylated (DM) peaks, PEALS use complex strategies to normalized the reads count under different conditions to avoid over-normalization.

Required third party software

PEALS relies on the following third party software. Before installing PEALS, please to ensure the following software have been properly installed.

The following R pacakges should be also installed.

Install

The common way to install PEALS is through PYPI).

Please check INSTALL document for detail.

Usage

Example for regular peak calling on MeRIP-seq.

For sample matrix, please chek the sample matrix here as reference.

peals callpeak -i <bam directory> -m <sample matrix> -P <prefix> -o <output directory>

Example for differentially methylated peak calling on MeRIP-seq.

For sample matrix, please chek the sample matrix here as reference.

peals diffpeak -i <bam directory> -m <sample matrix> -P <prefix> -o <output directory>

Subcommand Description
callpeak Main function to call peaks from alignment results.
diffpeak Main function to call differentially methylated peaks from alignment results.

Contribute

If you have any questions, suggestion/ideas, or just want to have conversions with developers and other users in the community, we recommand you using discussion section or posting to our Issues page.

Ackowledgement

PEALS project also relies on the following python packages.

peals's People

Contributors

kerenzhou062 avatar

Watchers

douxiaoyang avatar  avatar

peals's Issues

TypeError in peals callpeak

周老师您好,我在使用peals callpeak时出现几个问题
第一个错误如下:

(python38) root@1ef77f50eaef:/file# peals callpeak -i . -m PEALS/example/peals.callpeak.sample.txt -P peals -o peals \
>     --gsize /file/hg38.chrom.sizes \
>     --gff /file/Homo_sapiens.GRCh38.91.gtf \
>     --gff-type GTF
INFO  @ Wed, 23 Aug 2023 14:21:42: PEALS (v1.2.4) is running with following parameters: 
INFO  @ Wed, 23 Aug 2023 14:21:42: [input] parameter group: call-with-binary=False, binary-dir=None, input=., matrix=PEALS/example/peals.callpeak.sample.txt, recursive=False, type=mature, sample=None 
INFO  @ Wed, 23 Aug 2023 14:21:42: [output] parameter group: keep-temp=False, no-bwtrack=False, output=peals, prefix=peals, temp=None, verbose=2 
INFO  @ Wed, 23 Aug 2023 14:21:42: [library] parameter group: estlib-size=primary_mapped, extsize=0, library=2, pairend=False 
INFO  @ Wed, 23 Aug 2023 14:21:42: [normalize] parameter group: bw-scale=rpm, exp-method=count, estpeak-sizefactor=peak 
INFO  @ Wed, 23 Aug 2023 14:21:42: [bam] parameter group: exp-cutoff=1, frac-overlap=0, ignore-dup=False, no-fraction=False, scale-sample=to_small, sortbam=False 
INFO  @ Wed, 23 Aug 2023 14:21:42: [constant] parameter group: buffer=10000000, reltol=0.05, thread=10, thread-start=fork 
INFO  @ Wed, 23 Aug 2023 14:21:42: [annotation] parameter group: gff=/file/Homo_sapiens.GRCh38.91.gtf, gff-source=GENCODE, gff-type=GTF, gsize=/file/hg38.chrom.sizes, identifier=gene_id:gene_name:gene_type:transcript_id:transcript_name:transcript_type 
INFO  @ Wed, 23 Aug 2023 14:21:42: [peak] parameter group: center=0.25, complexity-rate=0.05, csaps-p=0.005, ipratio=1.25, lookahead=25, peak-size=35, span-loop=1, span-method=move, split=50000 
INFO  @ Wed, 23 Aug 2023 14:21:42: [model] parameter group: fit-type=parametric, formula=None, shrink=apeglm, test=Wald 
INFO  @ Wed, 23 Aug 2023 14:21:42: [filter] parameter group: fold=2, padj=0.05, padj-method=BH, pval=0.05 
INFO  @ Wed, 23 Aug 2023 14:21:42: Checking whether required third party software are properly installed... 
INFO  @ Wed, 23 Aug 2023 14:21:42: Congratulations! All required third party software are properly installed! 
Traceback (most recent call last):
  File "/root/.local/bin/peals", line 352, in <module>
    main()
  File "/root/.local/bin/peals", line 35, in main
    run( args )
  File "/root/.local/lib/python3.8/site-packages/PEALS/subcmd/callpeak_cmd.py", line 51, in run
    tempPrefix = os.path.join(options.tempdir, "_".join([options.tempre, options.prefix]))
  File "/root/mambaforge-pypy3/envs/python38/lib/python3.8/posixpath.py", line 76, in join
    a = os.fspath(a)
TypeError: expected str, bytes or os.PathLike object, not NoneType
INFO  @ Wed, 23 Aug 2023 14:21:42: Embedded R ended. 
INFO  @ Wed, 23 Aug 2023 14:21:42: Embedded R already ended. 

经过检查options后,确实发现options.tempdir=None ,使用-T参数即可解决这个问题
值得一提,在help内,有以下说明

-o OUTPUTDIR, --output OUTPUTDIR
                        All output files will be written to this directory. (default: None)
  -T TEMPDIR, --temp TEMPDIR
                        If specified, all temporary files will be written to this directory. Default is the same with --output.
                        (default: None)

说明上写的是默认和-o参数一致,但实际上没有一致,可能是老师您漏掉了这个地方。

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.