khmer icon indicating copy to clipboard operation
khmer copied to clipboard

Where can I find documentation on Countgraph ?

Open Nortalle opened this issue 5 years ago • 1 comments

Hey

I code in Python and I want to use Countgraph, but I can't find documentation on the parameters to pass. Only some insights on the example for the Python API.

Nortalle avatar Jul 19 '19 20:07 Nortalle

Hi @Nortalle!

Our documentation is definitely intended for users of khmer's command-line tools, rather than developers using the Python API. Still, the concepts discussed on this page are helpful.

A Countgraph object requires 3 parameters at construction time.

  1. a k-mer size
  2. a number of rows
  3. the (approximate) size of each row

The exact memory usage of the Countgraph object will be very close to the the product of parameter 2 and parameter 3. Hope this helps!

standage avatar Jul 24 '19 13:07 standage