|
a |
|
b/docs/api/user.md |
|
|
1 |
# User |
|
|
2 |
|
|
|
3 |
## Benchmarking |
|
|
4 |
|
|
|
5 |
```{eval-rst} |
|
|
6 |
.. module:: nichecompass.benchmarking |
|
|
7 |
.. currentmodule:: nichecompass |
|
|
8 |
|
|
|
9 |
.. autosummary:: |
|
|
10 |
:toctree: generated |
|
|
11 |
|
|
|
12 |
benchmarking.compute_benchmarking_metrics |
|
|
13 |
benchmarking.compute_cas |
|
|
14 |
benchmarking.compute_clisis |
|
|
15 |
benchmarking.compute_gcs |
|
|
16 |
benchmarking.compute_mlami |
|
|
17 |
benchmarking.compute_nasw |
|
|
18 |
``` |
|
|
19 |
|
|
|
20 |
## Data |
|
|
21 |
```{eval-rst} |
|
|
22 |
.. module:: nichecompass.data |
|
|
23 |
.. currentmodule:: nichecompass |
|
|
24 |
|
|
|
25 |
.. autosummary:: |
|
|
26 |
:toctree: generated |
|
|
27 |
|
|
|
28 |
data.load_spatial_adata_from_csv |
|
|
29 |
``` |
|
|
30 |
|
|
|
31 |
## Models |
|
|
32 |
|
|
|
33 |
```{eval-rst} |
|
|
34 |
.. module:: nichecompass.models |
|
|
35 |
.. currentmodule:: nichecompass |
|
|
36 |
|
|
|
37 |
.. autosummary:: |
|
|
38 |
:toctree: generated |
|
|
39 |
|
|
|
40 |
models.NicheCompass |
|
|
41 |
``` |
|
|
42 |
|
|
|
43 |
## Gene Program Utilities |
|
|
44 |
|
|
|
45 |
```{eval-rst} |
|
|
46 |
.. module:: nichecompass.utils |
|
|
47 |
.. currentmodule:: nichecompass |
|
|
48 |
|
|
|
49 |
.. autosummary:: |
|
|
50 |
:toctree: generated |
|
|
51 |
|
|
|
52 |
utils.add_gps_from_gp_dict_to_adata |
|
|
53 |
utils.add_multimodal_mask_to_adata |
|
|
54 |
utils.extract_gp_dict_from_collectri_tf_network |
|
|
55 |
utils.extract_gp_dict_from_nichenet_lrt_interactions |
|
|
56 |
utils.extract_gp_dict_from_mebocost_es_interactions |
|
|
57 |
utils.extract_gp_dict_from_omnipath_lr_interactions |
|
|
58 |
utils.filter_and_combine_gp_dict_gps |
|
|
59 |
utils.get_gene_annotations |
|
|
60 |
utils.generate_multimodal_mapping_dict |
|
|
61 |
utils.get_unique_genes_from_gp_dict |
|
|
62 |
utils.generate_enriched_gp_info_plots |
|
|
63 |
``` |
|
|
64 |
|
|
|
65 |
## Cell-Cell Communication Utilities |
|
|
66 |
|
|
|
67 |
```{eval-rst} |
|
|
68 |
.. module:: nichecompass.utils |
|
|
69 |
.. currentmodule:: nichecompass |
|
|
70 |
|
|
|
71 |
.. autosummary:: |
|
|
72 |
:toctree: generated |
|
|
73 |
|
|
|
74 |
utils.compute_communication_gp_network |
|
|
75 |
utils.visualize_communication_gp_network |
|
|
76 |
``` |
|
|
77 |
|
|
|
78 |
## Other Utilities |
|
|
79 |
```{eval-rst} |
|
|
80 |
.. module:: nichecompass.utils |
|
|
81 |
.. currentmodule:: nichecompass |
|
|
82 |
|
|
|
83 |
.. autosummary:: |
|
|
84 |
:toctree: generated |
|
|
85 |
|
|
|
86 |
utils.create_new_color_dict |
|
|
87 |
``` |