Skip to main content

RRBS tool for deleting artificial cytosins

Project description

# 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

irrbs-1.1.1.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iRRBS-1.1.1-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file irrbs-1.1.1.tar.gz.

File metadata

  • Download URL: irrbs-1.1.1.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for irrbs-1.1.1.tar.gz
Algorithm Hash digest
SHA256 158c8653a1d0e9a67301668338969fa9a9b1998122fa3863f8f2a1bb0e4b1234
MD5 7151ba7807429405318390ae71e51b8f
BLAKE2b-256 4670e8b4cd202ccd7614456f58f1a60f3b7db884f6086dc3ddd41442727cc5a3

See more details on using hashes here.

File details

Details for the file iRRBS-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: iRRBS-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for iRRBS-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c38525e7bcf4d0d6bd77dca13c3decebad13cf31c4dee7c192a730bb037d9f33
MD5 3ed2b0eaebff44a376c79d7e484aa03f
BLAKE2b-256 0020c6bbd45a94f4fb078dd046ec9e850e7014f4836564d4ef513129d2a92999

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page