Skip to main content

eliminates chimeric reads by comparing the UMI sequences and finding any matches in the 5 prime or 3 prime UMIs and keeping the sequence that has the highest prevalence

Project description

Chimera_Buster

Overview

This package takes concensus fasta files from the MrHamer pipeline and eliminates chimeric reads by comparing the UMI sequences and finding any matches in the 5' or 3' UMIs and keeping the sequence that has the highest prevalence.


Installation

Requires python<=3.10

Quick Install

pip install Chimera_Buster

Manual Install

git clone https://github.com/JessicaA2019/Chimera_Buster.git 
cd Chimera_Buster
python setup.py install

Dependencies

Some dependencies currently do not install with Chimera_Buster. Please pip install the following dependencies:

  • edlib
  • pandas
  • multiprocessing
  • argparse

Testing

To test if the installation was successful run the following command with the test files provided:

Chimera_Buster CB_test_files CB_test

Usage

Chimera_Buster [options] {input_folder_name} {output_file_prefix}

Inputs

To run the pipeline the following input files are required:

Input Description
input_folder_name Designates MrHAMER folder to be filtered. This is required.
output_file_prefix Designates output file prefix. This is required.
The following input files are optional:
Arguement Function
------ ------
-h, --help Prints help message to terminal.
-m int, --mismatch int Designates the maximum number of mismatched/indel bases allowed when comparing UMIs. Default is 1.

Outputs

The main output files created by the pipeline are:

Output Description
{output_file_prefix}_chimera_list.txt A list of all chimeric sample IDs.
{output_file_prefix}_nonchimera_list.txt A list of all nonchimeric sample IDs.
{output_file_prefix}_chimeras.csv A csv of the sample ID, UMI sequences, and cluster counts for each chimeric read.
{output_file_prefix}_nonchimeras.csv A csv of the sample ID, UMI sequences, and cluster counts for each nonchimeric read.

Help

For issues or bugs, please report them on the issues page.

License

MIT - Copyright (c) 2024 Jessica Lauren Albert

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

chimera_buster-1.1.3.tar.gz (8.6 kB view details)

Uploaded Source

Built Distribution

Chimera_Buster-1.1.3-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file chimera_buster-1.1.3.tar.gz.

File metadata

  • Download URL: chimera_buster-1.1.3.tar.gz
  • Upload date:
  • Size: 8.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for chimera_buster-1.1.3.tar.gz
Algorithm Hash digest
SHA256 0096682425834c681a406839a176798183cccc684718cdd99fa1926e67fdb09b
MD5 926e2bc131d7a2e00086beda72207adc
BLAKE2b-256 dbf9a2fba2ba4cb7e5663c0ea2b49aaf834e2f75258ce754e2f2f0db5544fa9e

See more details on using hashes here.

File details

Details for the file Chimera_Buster-1.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for Chimera_Buster-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bcf52ca8af068928f720f366a07b5bcad5a96fd9c94ecd816e0142ad2201b8f0
MD5 652de714244e862af27e06d74a49319c
BLAKE2b-256 b318130cef252a152d85076923cc24672f95b29226724668e21ffd3f830396ee

See more details on using hashes here.

Supported by

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