Skip to content
mattloose edited this page Oct 4, 2020 · 11 revisions

ReadFish Logo

Welcome

ReadFish provides a set of tools for running a variety of adaptive sampling or "Read Until" Experiments on the Oxford Nanopore Technologies platform of sequencers.

These tools provide real time manipulation of sequencing and - as such - are destructive. Your experimental results will be altered by the actions of this code. We therefore encourage users to test any code prior to running an experiment.

This wiki is a work in progress and will soon provide a detailed companion to the README file enclosed with this repository. At this time, the README is still the recommended resource for learning about ReadFish.

Testing

Before you run ReadFish we recommend that you test your setup. We provide full instructions for how to do this here.

Really REALLY Important Stuff

If you are anything like us, reading a README is the last thing you do when running code. PLEASE DON'T DO THAT FOR READFISH. This will effect changes to your sequencing and - if you use it incorrectly - cost you money. We have added a list of GOTCHAs to this WIKI. We have almost certainly missed some... so - if something goes wrong, let us know so we can add you to the GOTCHA hall of fame!