Create SourceTracker2 api about sourcetracker2 HOT 4 CLOSED

PR #32 addresses this, though it needs to be cleaned up significantly.

from sourcetracker2.

We should decide, as a whole, what functions we would like to be part of the public, stable API. We should then ensure that we have valid numpydoc for all of those functions. We should err on the side of a minimal API as it's easy to add new things to the API, but very hard to remove them. I agree that the _gibbs is almost there. You guys should work with this in the alpha release that I create to decide if it's what we want in the public API (which maybe we can try for in a beta release). I think this should possibly be the only function that's part of the public API, in which case maybe it should be renamed sourcetracker and take a mode parameter where you can pass gibbs (similar to skbio.diversity.beta_diversity and its metric parameter).

from sourcetracker2.

@wdwvt1 and I discussed also making the sourcetracker result comparison function (#57) accessible through the public API. Then the initial public API would be these imports:

from sourcetracker import sourcetracker, compare

from sourcetracker2.

Added in #71.

from sourcetracker2.