Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation and support for other implementations of MinHash and FracMinHash #2284

Open
5 tasks
ctb opened this issue Sep 15, 2022 · 2 comments
Open
5 tasks

Comments

@ctb
Copy link
Contributor

ctb commented Sep 15, 2022

revisiting a (5 yro :) conversation about interoperability marbl/Mash#27 after some discussions on slack with @kescobo on µbioinfo slack. See also a motivating question about implementations in BioJulia BioJulia/BioSequences.jl#243 and this issue in rkmh edawson/rkmh#3.

Here in sourmash, I think we could do more to support alternative implementations of MinHash and FracMinHash in other projects. I'll update this issue more as I think through them, but off the top of my head -

  • provide both very simple and more complicated example sketches, sequence files, and simple Python code to run them all
  • provide Jaccard (MinHash) and Jaccard, containment x 2, avg containment, max containment, and angular similarity (FracMinHash) numbers, as well as providing the underlying equations
  • describe the current sourmash JSON format and provide simple example import/export scripts for sourmash in Python and R (since we already have them ;)
  • talk about converting sourmash sketches from (e.g.) wort into regular minhash, where possible. (that is, sourmash sig downsample)
  • show how to download, export, make use of some SRA sketches

The goal is to make it easy for others to implement simple test suites to check on interoperability of the actual sketching and sketch comparison code.

@ctb
Copy link
Contributor Author

ctb commented Sep 15, 2022

on slack, luiz pointed out that we already have good Rust interoperability b/c, well, if you scratch sourmash's Python layer just a little bit, you find Rust underneath. And:

There is a C header for doing the interaction between Rust and Python, here: https://github.com/sourmash-bio/sourmash/blob/latest/include/sourmash.h

@ctb
Copy link
Contributor Author

ctb commented Sep 15, 2022

also: we should provide some simple example code for making use of some of our pre-computed sketches from wort, and converting them into mash-usable sketches.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant