DBPeaks 0.0.3__tar.gz

dbpeaks-0.0.3/DBPeaks.egg-info/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.4
+Name: DBPeaks
+Version: 0.0.3
+Summary: A tool for identifying differentially bound peaks in CLIP/CRAC data
+Author-email: Sander Granneman <Sander.Granneman@ed.ac.uk>
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pybedtools
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: pydeseq2==0.4.9
+Requires-Dist: pyCRAC==1.5.2
+Dynamic: license-file
+
+# DBPeaks: Differential RNA-Binding Site Analysis Tool
+
+## Contents
+
+- [Introduction](#introduction)
+
+- [Repo Contents](#repo-contents)
+
+- [Features](#features)
+
+- [System Requirements](#system-requirements)
+
+- [Installation Guide](#installation-guide)
+
+- [License](./LICENSE)
+
+- [Citation](#citation)
+
+- [Contact](#contact)
+
+## Inroduction
+
+DBPeaks is a Python-based command-line tool designed for the identification and analysis of differential RNA-binding sites in CLIP/CRAC datasets. It integrates various bioinformatics tools and methods to process sequencing data, identify peaks, and perform statistical analyses to detect significant differences in RNA-binding across conditions. It does so by first analysing the peaks in each individual file and it then looks whether peaks are found in the same regions. These peaks need to have overlapping genome mapping coordinates. All overlapping peaks will then be merged into a single peak interval and for each interval the program will then calculate the total number of reads covering that genomic interval. DESeq2 will then be used to determine if the read counts for that interval is statistically significantly different between sample and control files.
+
+It requires CLIP/CRAC data BAM files as input as well as GTF and genome files for the model organism.
+Make sure your GTF annotation file does not have any silly formatting mistakes, otherwise the program will not run.
+Example genome files for yeast are available in this repository.
+
+NOTE! DBPeaks was SPECIFICALLY designed to analyse CLIP/CRAC datasets from two different conditions or by comparing data from WT vs mutant RBPs. It was NOT designed to compare RBP CLIP datasets to control datasets that have substantially lower read counts (i.e. data from untagged strains or no UV cross-linking controls). Should you be stubborn and still decide to use DBPeaks for this purpose, you will get rubbish results! 
+
+It is really important that all bam files have good number of reads and that there is not a huge difference in read depth between the files. This will make DESeq2 much happier and will therefore improve the results.
+
+We have tried many different tools that do similar things. However, we were either not able to get them running on our servers or they were not able to detect clearly differentially bound (DB) peaks in our data. We have not benchmarked DBPeaks to existing tools so we do not yet know how well it performs compared to most popular peak calling methods. All I can say is that on OUR data where we removed an RBP binding site in the genome it performs better than existing tools such as MACS3 and Peakachu. DBPeaks was able to detect loss of binding in that single genomic location. The other tools we tested could not. DBPeaks is, however, slower than most existing tools. This is because it relies on pyCalculateFDRs from the pyCRAC package to call peaks. This script looks for peaks in each individual gene anotated in the genome and takes read coverage of the gene into consideration for this. So this part is rather slow if you have many features annotated in your genome file. 
+
+DBPeaks uses multiple CPUs to process the data and has the added advantage that it can also use replicates.
+
+## Repo Contents
+- [DBPeaks](./DBPeaks.py)
+- [License](./LICENSE)
+
+## Features
+
+Comprehensive Analysis Pipeline: From reading BAM files to statistical analysis with DESeq2.
+Parallel Processing: Utilizes multiple CPUs to speed up the analysis.
+Flexible Input Options: Supports various configurations and customizations through command-line options.
+Integrated Peak Calling and Filtering: Includes functionality for peak detection, filtering based on reproducibility, and adjustment of peak widths.
+Statistical Analysis: Incorporates DESeq2 for rigorous differential analysis.
+
+## Installation Guide
+
+### Prerequisites
+
+Python 3.6 or higher
+Dependencies: pybedtools, numpy, pandas, pydeseq2, pyCRAC, and others as listed in requirements.txt.
+Steps
+
+Clone the repository:
+
+```
+git clone https://git.ecdf.ed.ac.uk/sgrannem/dbpeaks.git
+cd dbpeaks
+```
+
+### Install required Python packages:
+
+```
+pip install -r requirements.txt
+```
+
+### Install DBPeaks:
+
+```
+cd dbpeaks
+pip install -e . --user
+```
+
+### Running DBPeaks
+
+DBPeaks is run from the command line. Here is a basic example to get you started:
+
+python dbpeaks.py --samples path/to/sample1.bam path/to/sample2.bam --controls path/to/control1.bam path/to/control2.bam --gtf path/to/annotation.gtf --chromfile path/to/chrominfo.txt --jobname ExampleAnalysis
+
+### Command-Line Options
+
+--samples: Specify paths to the BAM files for the sample group.
+--controls: Specify paths to the BAM files for the control group.
+--gtf: Path to the GTF annotation file.
+--chromfile: Location of the chromosome info file. This file should have two columns: first column is the names of the chromosomes, second column is length of the chromosomes.
+--jobname: A name for the job to organize output files.
+
+### Additional options for peak calling, filtering, and statistical thresholds can be viewed using the help option:
+
+```
+DBpeaks.py --help
+```
+
+### Peak calling settings:
+  -m 0.05, --minfdr 0.05  To set a minimal FDR threshold for filtering interval data. Default is 0.05
+
+This is a setting that is used when running pyCalculateFDRs. If you end up getting a lot of peaks in your data,
+it is recommended to change this threshold, let's say to 0.01 as this will reduce the number of significantly enriched peaks
+in your data.
+                        
+  --padj 0.05           DESeq2 threshold for calling a peak DB. Default is 0.05
+
+If you hardly get any DB peaks, then it may be worth slighly adjusting this threshold.
+However, in this scenario, it may also be the case that your samples just have too much variability. 
+It may then be wise to do a PCA analysis on your data to see if replicates are indeed grouped together.
+
+  --min 5               to set a minimal read coverages for a region. Regions with coverage less than minimum will be ignored
+
+  --blocks              Add this flag if you want to consider reads with identical mapping coordinates once, regardless of sequence.
+
+NOTE! This is a HUGELY important flag! Setting --blocks will remove any 'towers' in your data and collapse them into
+one single interval. This can completely change the shape and height of the peak and the peak may no longer be detected.
+However, if you suspect that your library is of low complexity and you see many of these blocks or towers in your genome browser, then I would recommend adding this flag as I have seen that this can improve the reliability of the final DESeq2 analyses.
+
+  --iterations 100      to set the number of iterations for randomization of read coordinates. Default=100
+                        
+This is important for the peak calling analysis by the pyCalculateFDR.py script.
+
+
+  -r 90, --rep 90       To set in what percentage of the replicates the peak should be detected. Default=100
+
+Let's say you have three sample and three control bam files and you set -r to 50, then peaks that are, for example present in the smaple files but absent in the control files will also be considered. If you, in this scenario, set -r to 100, then the tool will expect to find overlapping peaks at any given position for ALL samples! So you may miss peaks that were, for example, only present in your sample but not in the control!
+
+  --filter mean         To filter the peaks in gtf files by a specific threshold. Options are mean, median or mean plus one standard devation 
+                        (mean_plus_std) peak heights. Default is no filtering.
+
+I would always recommend starting with no filtering. If you get too many DB peaks, then I would start with --filter mean and then --filter median.
+
+  --min_peak_width 20   To set the minimum width of a called peak. Default = 20
+
+
+## Contributing to further improving DBPeaks
+
+Contributions to DBPeaks are welcome! Please fork the repository and submit pull requests with your enhancements.
+We will also be including some test data on the repository soon!
+
+## License
+
+This project is licensed under the Apache License - see the LICENSE file for details.
+
+
+## Citation
+
+DBPeaks was developed to analyse CRAC data for a manuscript that we are about to submit. This will be updated once the paper has been accepted or put on a preprint server.
+
+## Contact
+
+For support or to report issues, please contact Sander Granneman at Sander.Granneman@ed.ac.uk, University of Edinburgh.

dbpeaks-0.0.3/DBPeaks.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+DBPeaks.py
+LICENSE
+README.md
+pyproject.toml
+DBPeaks.egg-info/PKG-INFO
+DBPeaks.egg-info/SOURCES.txt
+DBPeaks.egg-info/dependency_links.txt
+DBPeaks.egg-info/entry_points.txt
+DBPeaks.egg-info/requires.txt
+DBPeaks.egg-info/top_level.txt

dbpeaks-0.0.3/DBPeaks.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

dbpeaks-0.0.3/DBPeaks.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+dbpeaks = DBPeaks:main

dbpeaks-0.0.3/DBPeaks.egg-info/requires.txt

@@ -0,0 +1,5 @@
+pybedtools
+numpy
+pandas
+pydeseq2==0.4.9
+pyCRAC==1.5.2

dbpeaks-0.0.3/DBPeaks.egg-info/top_level.txt

@@ -0,0 +1 @@
+DBPeaks