|
a |
|
b/docs/source/api.rst |
|
|
1 |
API Guide |
|
|
2 |
============== |
|
|
3 |
|
|
|
4 |
aggmap has two major classes :class:`AggMap` and :class:`AggMapNet`. |
|
|
5 |
|
|
|
6 |
AggMap |
|
|
7 |
---- |
|
|
8 |
|
|
|
9 |
.. autoclass:: aggmap.map.AggMap |
|
|
10 |
:members: |
|
|
11 |
|
|
|
12 |
|
|
|
13 |
AggMapNet |
|
|
14 |
---- |
|
|
15 |
|
|
|
16 |
.. automodule:: aggmap.AggMapNet |
|
|
17 |
:members: |
|
|
18 |
|
|
|
19 |
|
|
|
20 |
|
|
|
21 |
A number of internal functions can also be accessed separately for more fine tuned work. |
|
|
22 |
|
|
|
23 |
Useful Functions |
|
|
24 |
---------------- |
|
|
25 |
|
|
|
26 |
.. automodule:: aggmap.aggmodel.explainer |
|
|
27 |
:members: |
|
|
28 |
|
|
|
29 |
.. automodule:: aggmap.utils.vismap |
|
|
30 |
:members: |
|
|
31 |
|
|
|
32 |
.. automodule:: aggmap.utils.summary |
|
|
33 |
:members: |
|
|
34 |
|
|
|
35 |
.. automodule:: aggmap.utils.gen_nwk |
|
|
36 |
:members: |