Skip to content

Commit

Permalink
Update README.md, CHANGELOG.md, duplex_tools/__init__.py
Browse files Browse the repository at this point in the history
  • Loading branch information
ollenordesjo committed May 30, 2023
1 parent 0277862 commit eb3bd55
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 2 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).


## [v0.3.3]
### Added
- Deprecation warning. Update sam->bam in readme.

## [v0.3.2]
### Added
- Update to `dorado_stereo.sh`, do not create directories when using -n flag (dry run).
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
![Oxford Nanopore Technologies logo](https://github.com/nanoporetech/medaka/raw/master/images/ONT_logo_590x106.png)

> **Deprecation notice**
> Please note that the functionality in this repository is superseded by integrated pairing in [Dorado](https://github.com/nanoporetech/dorado/tree/master/dorado).
> This means it's no longer necessary to use pairing or dorado_stereo.sh in order to perform end-to-end duplex calling.
# Duplex Tools

Duplex Tools contains a set of utilities for dealing with Duplex sequencing
Expand Down Expand Up @@ -58,7 +62,7 @@ For greatest duplex recovery, follow these steps:
This will create an (unmapped) .sam file which has a mapping between the signal and bases.
`--emit-moves` allows for additional pairs to be found in step 2b.

$ dorado basecaller dna_r10.4.1_e8.2_400bps_fast@v4.0.0 pod5s/ --emit-moves > unmapped_reads_with_moves.sam
$ dorado basecaller dna_r10.4.1_e8.2_400bps_fast@v4.0.0 pod5s/ --emit-moves > unmapped_reads_with_moves.bam

### 2a) Find duplex pairs for Dorado stereo/basespace basecalling
This will detect the majority of pairs and put them in the `pairs_from_bam` directory.
Expand Down
2 changes: 1 addition & 1 deletion duplex_tools/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"split_on_adapter", "assess_split_on_adapter",
"pairs_from_summary", "filter_pairs", "pair", "split_pairs"]

__version__ = '0.3.2'
__version__ = '0.3.3'


def main():
Expand Down

0 comments on commit eb3bd55

Please sign in to comment.