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 MrHamer2.0 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
Usage
Chimera_Buster [options] {input_file_name} {input_prelim_name} {output_file_prefix}
Inputs
To run the pipeline the following input files are required:
Input | Description |
---|---|
input_file_name | Designates clusters_concesus.fasta file from the clustering_consensus folder to be filtered. This is required. |
input_prelim_name | Designates clusters_concesus.fasta file from the clustering 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. |
-c True/False, --check_clusters True/False | When set to true, chimeric reads are rechecked to account for any clustering issues earlier in the pipeline. WARNING: this part of the code is slow and is only recommended for low input samples. Default is False. |
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}_non_chimeras.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
Built Distribution
File details
Details for the file chimera_buster-1.2.0.tar.gz
.
File metadata
- Download URL: chimera_buster-1.2.0.tar.gz
- Upload date:
- Size: 9.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a506c829d8bece0e988be8d0d84a0355068c594686d29ead7913fa2cee5bdb67 |
|
MD5 | ac8170d4f36516e2526fbd5102b6953b |
|
BLAKE2b-256 | 32d786f6cf543081cf197951c077286b00404416a19dcd23718518a8b707a66b |
File details
Details for the file Chimera_Buster-1.2.0-py3-none-any.whl
.
File metadata
- Download URL: Chimera_Buster-1.2.0-py3-none-any.whl
- Upload date:
- Size: 8.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 063a6ed3eb605f7d94d48ece62a8a8d13661661f4ebc91aa4567b22a1b253668 |
|
MD5 | 6572aa81cd543a6d308ae0745c5f6d4b |
|
BLAKE2b-256 | ca53b422ab8891354b273711547ac78c763b4a91035865309d5663e227b4030d |