Skip to content

Commit 16951e3

Browse files
author
Andrew Ramirez
committed
Update api documentation
1 parent 6094b04 commit 16951e3

File tree

1 file changed

+59
-6
lines changed

1 file changed

+59
-6
lines changed

docs/api.rst

Lines changed: 59 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,79 @@
11
API Reference
22
=============
33

4-
.. automodule:: RISE
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
4+
Core Functions
5+
--------------
6+
7+
Factorization
8+
~~~~~~~~~~~~~
89

910
.. automodule:: RISE.factorization
10-
:members:
11+
:members: pf2, rise_pca_r2x, correct_conditions
1112
:undoc-members:
1213
:show-inheritance:
1314

15+
Data Import
16+
~~~~~~~~~~~
17+
1418
.. automodule:: RISE.imports
15-
:members:
19+
:members: import_thomson, import_lupus
1620
:undoc-members:
1721
:show-inheritance:
1822

23+
Preprocessing
24+
~~~~~~~~~~~~~
25+
26+
.. autofunction:: parafac2.normalize.prepare_dataset
27+
28+
Visualization Functions
29+
-----------------------
30+
31+
General Plotting
32+
~~~~~~~~~~~~~~~~
33+
34+
.. automodule:: RISE.figures.commonFuncs.plotGeneral
35+
:members: plot_r2x
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
Factor Plotting
40+
~~~~~~~~~~~~~~~
41+
42+
.. automodule:: RISE.figures.commonFuncs.plotFactors
43+
:members: plot_condition_factors, plot_eigenstate_factors, plot_gene_factors
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
PaCMAP Visualization
48+
~~~~~~~~~~~~~~~~~~~~
49+
50+
.. automodule:: RISE.figures.commonFuncs.plotPaCMAP
51+
:members: plot_labels_pacmap, plot_gene_pacmap, plot_wp_pacmap
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
Factor Stability
56+
~~~~~~~~~~~~~~~~
57+
58+
.. automodule:: RISE.figures.figureS4
59+
:members: plot_fms_diff_ranks, calculateFMS
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
Additional Modules
64+
------------------
65+
66+
Logistic Regression
67+
~~~~~~~~~~~~~~~~~~~
68+
1969
.. automodule:: RISE.logisticReg
2070
:members:
2171
:undoc-members:
2272
:show-inheritance:
2373

74+
Cell Gating
75+
~~~~~~~~~~~
76+
2477
.. automodule:: RISE.gating
2578
:members:
2679
:undoc-members:

0 commit comments

Comments
 (0)