Skip to main content

# improve-RRBS tool ## Overview 3’ ends of RRBS reads overlapping with genomic MspI sites include non-methylated cytosines introduced through end-repair. These cytosines are not recognized by Trim Galore and are therefore not trimmed but considered during methylation calling. To avoid methylation bias we developed improve-RRBS, which identifies and hides end-repaired cytosines from methylation calling.

## Features - Detecting whether the input file is single-read or paired-end - Logging the “Number of unique MspI reads”, the “Number of MspI reads” and the “Number of all reads” - Outputting a BAM file without the biased cytosines

## Installation improve-RRBS can be installed by pip: pip install iRRBS

## Usage

python -m iRRBS.run_irrbs -i <infile> -c <chromsizes> -g <genome> -o <outputfile>

To run improve-RRBS the following input parameters are required in this order: - infile (-i): path to input sorted BAM file with an associated index file - chromsizes (-c): path to chrom.sizes file to define the chromosome lengths for a given genome - genome (-g): path to genome file - outfile (-o): name for the output file

## Setup and Test Instructions This guide walks you through the process of testing the iRRBS (IMPROVE-RRBS) analysis tool using a specific genomic data file. Follow these steps to ensure everything is set up and running correctly. Prerequisites

Before you begin, ensure you have the following installed:

  • Python

  • samtools

  • bedtools

### Test Data Preparation

Unzip the rn6 chromosome 20 fasta file

The rn6 (Rattus norvegicus) chromosome 20 fasta file comes compressed. Use the following command to decompress it:

gunzip rn6_chr20.fa.gz

### Run iRRBS

With the data prepared, run the iRRBS tool using the command below. Test data can be found in the “test_data” folder. This command specifies the input BAM file, chromosome sizes file, genome fasta file, and the output file names.

python -m iRRBS.run_irrbs -i test_data.bam -c rn6_chr20.chrom.sizes -g rn6_chr20.fa -o test_data_out_test.bam

### Log File

After running the test, a log file named test_data_out_test.log will be generated. This file contains information about the summary statistics of the analysis.

Please ensure you check the log file for any potential issues or to verify the successful completion of the test. Compare it with the test_data_out.log file from the test_data folder.

Metadata

Release files for iRRBS 1.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for iRRBS 1.1.1
File Size Uploaded Provenance Actions
irrbs-1.1.1.tar.gz 6.1 kB Without provenance Details for irrbs-1.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for iRRBS 1.1.1
File Interpreter ABI Platform Actions
iRRBS-1.1.1-py3-none-any.whl Python 3 none any Details for iRRBS-1.1.1-py3-none-any.whl

Total release size: 12.7 kB

Release files / irrbs-1.1.1.tar.gz

Download URL irrbs-1.1.1.tar.gz
Size 6.1 kB
Tags Source
SHA-256 checksum
How to use checksums
158c8653a1d0e9a67301668338969fa9a9b1998122fa3863f8f2a1bb0e4b1234
BLAKE2b-256 checksum
How to use checksums
4670e8b4cd202ccd7614456f58f1a60f3b7db884f6086dc3ddd41442727cc5a3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.10.12

Release files / iRRBS-1.1.1-py3-none-any.whl

Download URL iRRBS-1.1.1-py3-none-any.whl
Size 6.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c38525e7bcf4d0d6bd77dca13c3decebad13cf31c4dee7c192a730bb037d9f33
BLAKE2b-256 checksum
How to use checksums
0020c6bbd45a94f4fb078dd046ec9e850e7014f4836564d4ef513129d2a92999
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.10.12

Security for iRRBS 1.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.1.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page