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

Where can I find documentation on Countgraph ? #1892

Open
Nortalle opened this issue Jul 19, 2019 · 1 comment
Open

Where can I find documentation on Countgraph ? #1892

Nortalle opened this issue Jul 19, 2019 · 1 comment

Comments

@Nortalle
Copy link

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.

@standage
Copy link
Member

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!

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

2 participants