Metadata-Version: 2.4
Name: dsrnascan
Version: 0.6.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
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
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Requires-Dist: biopython>=1.78
Requires-Dist: numpy>=1.19
Requires-Dist: pandas>=1.1
Requires-Dist: viennarna>=2.4
Requires-Dist: psutil>=5.8
Requires-Dist: tqdm>=4.0
Requires-Dist: ydf>=0.9.0
Requires-Dist: scikit-learn>=1.0
Requires-Dist: pytest>=6.0 ; extra == 'dev'
Requires-Dist: pytest-cov>=2.0 ; extra == 'dev'
Requires-Dist: black>=22.0 ; extra == 'dev'
Requires-Dist: flake8>=4.0 ; extra == 'dev'
Requires-Dist: mypy>=0.900 ; extra == 'dev'
Requires-Dist: mpi4py>=3.0 ; extra == 'mpi'
Requires-Dist: parasail>=1.2 ; extra == 'mpi'
Provides-Extra: dev
Provides-Extra: mpi
License-File: LICENSE
Summary: A tool for genome-wide prediction of double-stranded RNA structures
Keywords: bioinformatics,RNA,dsRNA,secondary structure,genomics
Author: Bass Lab
License: GPL-3.0-or-later
Requires-Python: >=3.8
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Bug Tracker, https://github.com/Bass-Lab/dsRNAscan/issues
Project-URL: Documentation, https://github.com/Bass-Lab/dsRNAscan/blob/main/README.md
Project-URL: Homepage, https://github.com/Bass-Lab/dsRNAscan
Project-URL: Repository, https://github.com/Bass-Lab/dsRNAscan

# dsRNAscan

[![CI Tests](https://github.com/rjandr/dsRNAscan/actions/workflows/ci-simple.yml/badge.svg)](https://github.com/rjandr/dsRNAscan/actions/workflows/ci-simple.yml)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

**dsRNAscan** is a bioinformatics tool for genome-wide identification of **double-stranded RNA (dsRNA) structures**. It uses a sliding window approach to detect inverted repeats that can form dsRNA secondary structures, with support for **G-U wobble base pairing** and **ML-based scoring**.

Browse human genome results at [dsrna.chpc.utah.edu](http://dsrna.chpc.utah.edu)

## Install

```bash
pip install dsrnascan
```

Linux and macOS, Python 3.8+ (Windows: use WSL). If ViennaRNA fails via pip, install it with conda: `conda install -c bioconda viennarna`

## Usage

```bash
# Basic scan (defaults: -w 10000 -s 500 --score 75 -c 4)
dsrnascan input.fasta

# Scan a region
dsrnascan genome.fasta --only_seq chr21 --start 33455482 --end 33655482

# Faster fold (~99% identical results)
dsrnascan genome.fasta --banded -c 8

# Settings used for the human dsRNAome resource
dsrnascan genome.fasta --v1
```

| Parameter | Default | Description |
|-----------|---------|-------------|
| `-w` | 10000 | Window size (bp) |
| `-s/--step` | 500 | Step size between windows |
| `-c/--cpus` | 4 | Number of CPUs |
| `--score` | 75 | Minimum einverted score |
| `--paired_cutoff` | 70 | Minimum % paired bases |
| `--only_seq`, `--start/--end` | Full sequence | Chromosome and region to scan |
| `--banded` | False | Faster fold (~99% identical results) |
| `--v1` | False | Settings used for the human dsRNAome resource |
| `--format` | bedpe | Output format: `bedpe`, `gff3`, or `both` |

Run `dsrnascan --help` for all options.

## Output

- **`*_merged_results.txt`**: one row per dsRNA with coordinates, einverted score, RNAduplex fold, structure and ML scores
- **`*.bedpe`**: paired arm coordinates (default)
- **`*.gff3`**: arms as linked features for IGV (`--format gff3` or `both`)
- **`*.bp`**: base-pair arcs for IGV

## Browse Results

```bash
# Interactive viewer with Forna RNA structure visualization
dsrna-browse results_directory/

# With RNA editing site annotations (BED or GFF3)
dsrna-browse results_directory/ --editing-file editing_sites.bed
```

## Citation

If you use dsRNAscan, please cite:

> dsRNAscan maps human dsRNAome, revealing conservation, intermolecular dsRNA, and correlates of ADAR dependency.
> *Molecular Cell* (2026). https://doi.org/10.1016/j.molcel.2026.08.001

## License

GNU General Public License v3.0 - see [LICENSE](LICENSE). **Issues:** [GitHub Issues](https://github.com/Bass-Lab/dsRNAscan/issues)

## Acknowledgments

- EMBOSS einverted (search) and ViennaRNA duplexfold (folding), both reimplemented in dsRNAscan's compiled engine

