readfish icon indicating copy to clipboard operation
readfish copied to clipboard

add live poly a and skip poly a feature

Open satriobio opened this issue 1 year ago • 1 comments

  • crude, signal-space, live poly-a length estimation
  • skip basecall when chunks is poly-a sequence

satriobio avatar May 04 '24 00:05 satriobio

HI @satriobio, can you add docstrings to the function and module for Stringray, so it's easier to understand what it is doing?

A good example is targets.py, with the module level docstring at the top and the functions having individal docstrings.

Also code like this that doesn't rely on outside tools too much is a great candidate for Unit/DocTests - examples of which can be found here https://github.com/LooseLab/readfish/blob/778d260d2717117b8daa09177f4287026b0b0fe2/src/readfish/plugins/utils.py#L106-L123

We use pytest for performing these tests, which can be set up locally as detailed in the CONTRIBUTING.md and in greater detail in the online documentation.

Also one thing I recommend is to use pre-commit locally as detailed in the developer documentation, and set the hooks for pre-commit and pre-push, helps you keep your code tidy as you go!

Adoni5 avatar May 07 '24 10:05 Adoni5

This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.

github-actions[bot] avatar Jun 22 '24 02:06 github-actions[bot]