medaka icon indicating copy to clipboard operation
medaka copied to clipboard

Preciser description of all terms used to describe medaka models

Open BCArg opened this issue 2 years ago • 0 comments

Medaka is a Research Release.

Research releases are provided as technology demonstrators to provide early access to features or stimulate Community development of tools. Support for this software will be minimal and is only provided directly by the developers. Feature requests, improvements, and discussions are welcome and can be implemented by forking and pull requests. However much as we would like to rectify every issue and piece of feedback users may have, the developers may have limited resource for support of this software. Research releases may be unstable and subject to rapid iteration by Oxford Nanopore Technologies.

We provide no guarantees that feature requests will be implemented. They may be implemented if sufficient interest is generated or if the request aligns with research objectives.

Is your feature request related to a problem? Please describe. Would be nice to have a clear description/ table of what all the terms used to describe the models are. I know from the README page that 'hac' is high accuracy, though I see that there are new models at v1.6.1, and the new term used sup (e.g. r104_e81_sup_g5015_model.tar.gz). Intuitively I guess this refers to the super high accuracy basecaller, though it would be nice to be 100% sure about that

Describe the solution you'd like

  1. expand the 'Models' section on the README page, with a table of all used terms e.g. r104, min, fast. sup etc. and what they mean
  2. potentially add this extra information/ table to be printed when medaka tools list\_models is called

Describe alternatives you've considered NA

Additional context NA

BCArg avatar Jun 28 '22 10:06 BCArg