Skip to content

Commit

Permalink
feat: first version in the new repository
Browse files Browse the repository at this point in the history
  • Loading branch information
clintval committed Jul 26, 2024
1 parent 83e47d4 commit e4fd1d0
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Install with the Conda or Mamba package manager after setting your [Bioconda cha
❯ conda install neodisambiguate
```

#### Introduction
### Introduction

Disambiguation of aligned reads is performed per-template and all information across primary, secondary, and supplementary alignments is used as evidence.
Alignment disambiguation is commonly required when analyzing sequencing data from transduction, transfection, transgenic, or xenographic (including patient derived xenograft) experiments.
Expand All @@ -31,21 +31,21 @@ Input BAMs of arbitrary sort order are accepted, however, an internal sort to qu
All output BAM files will be written in the same sort order as the input BAM files.
Although paired-end reads will give the most discriminatory power for disambiguation of short-read sequencing data, this tool accepts paired, single-end (fragment), and mixed pairing input data.

#### Features
### Features

- Accepts SAM/BAM sources of any sort order
- Will disambiguate an arbitrary number of BAMs, all aligned to different references
- Writes the ambiguous alignments to a separate directory
- Extensible implementation which supports alternative disambiguation strategies
- Benchmarks show high accuracy: [Click Here](benchmarks/disambiguate.md)

#### Command Line Usage
### Command Line Usage

```bash
❯ neodisambiguate -i infile1.bam infile2.bam -p out/disambiguated
```

#### Example Usage
### Example Usage

To disambiguate templates for sample `dna00001` that are aligned to human (A) and mouse (B):

Expand All @@ -67,7 +67,7 @@ To disambiguate templates for sample `dna00001` that are aligned to human (A) an
└── dna00001.mm10.bam
```

#### Local Installation
### Local Installation

Bootstrap compilation and build the executable with:

Expand All @@ -76,7 +76,7 @@ Bootstrap compilation and build the executable with:
./bin/neodisambiguate --help
```

#### Prior Art
### Prior Art

This project was inspired by AstraZeneca's `disambiguate`:

Expand Down
2 changes: 1 addition & 1 deletion benchmarks/disambiguate.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ As a preliminary test, we will attempt to disambiguate simulated paired-end read
[mm10-reference]: https://rgd.mcw.edu/rgdweb/report/gene/main.html?id=1332211
[rn6-reference]: https://rgd.mcw.edu/rgdweb/report/gene/main.html?id=1584969

#### Dependencies
### Dependencies

- [`bwa`](https://bioconda.github.io/recipes/bwa/README.html)
- [`dwgsim`](https://anaconda.org/bioconda/dwgsim)
Expand Down

0 comments on commit e4fd1d0

Please sign in to comment.