Skip to content

Commit c8ab2c9

Browse files
committed
correct naming in tutorials
1 parent 73b2d28 commit c8ab2c9

3 files changed

Lines changed: 16 additions & 16 deletions

File tree

docs/notebooks/Nichesphere_tutorial_MIvisium_coloc.ipynb

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
"id": "ecc6a985-29a7-44e4-8f27-c6a8883f3a41",
66
"metadata": {},
77
"source": [
8-
"# Nichesphere differential co-localization tutorial\n",
8+
"# NicheSphere differential co-localization tutorial\n",
99
"\n",
10-
"Nichesphere is an sc-verse compatible Python library which allows the user to find differentially co-localized cellular niches and biological processes involved in their interactions based on cell type pairs co-localization probabilities in different conditions. Cell type pair co-localization probabilities are obtained in different ways: from deconvoluted Visium 10x / PIC-seq data (probabilities of finding each cell type in each spot / multiplet), or counting cell boundaries overlaps for each cell type pair in single cell spatial data (MERFISH , CODEX ...). This tutorial focuses on defining groups of cells that converge or split in disease (Ischemia) based on differential co-localization. \n",
10+
"NicheSphere is an sc-verse compatible Python library which allows the user to find differentially co-localized cellular niches and biological processes involved in their interactions based on cell type pairs co-localization probabilities in different conditions. Cell type pair co-localization probabilities are obtained in different ways: from deconvoluted Visium 10x / PIC-seq data (probabilities of finding each cell type in each spot / multiplet), or counting cell boundaries overlaps for each cell type pair in single cell spatial data (MERFISH , CODEX ...). This tutorial focuses on defining groups of cells that converge or split in disease (Ischemia) based on differential co-localization. \n",
1111
"\n",
12-
"Nichesphere also offers the possibility to look at localized differential cell - cell communication based on Ligand-Receptor pairs expression data, such as results from CrossTalkeR [ref]. This is addressed in the localized differential communication tutorial.\n"
12+
"NicheSphere also offers the possibility to look at localized differential cell - cell communication based on Ligand-Receptor pairs expression data. This is addressed in the localized differential communication tutorial.\n"
1313
]
1414
},
1515
{
@@ -1558,7 +1558,7 @@
15581558
"id": "78eb6625-c82e-482e-80a1-6eddfcfe92b9",
15591559
"metadata": {},
15601560
"source": [
1561-
"Now we can plot the differential co-localization network using the **colocNW** function from Nichesphere. This function has many parameters that can be tuned: \n",
1561+
"Now we can plot the differential co-localization network using the **colocNW** function from NicheSphere. This function has many parameters that can be tuned: \n",
15621562
"\n",
15631563
"**nodeSize** for example, defines how the size of the nodes will be calculated. Options are 'betweeness', 'pagerank' (both network statistics) and None (all nodes have the same size).\n",
15641564
"**alpha** indicates the transparency of the edges and in goes from 0 (completely transparent) to 1 (opaque)\n",
@@ -1851,7 +1851,7 @@
18511851
"id": "c832201e-b235-4314-a694-c5d4b7f53ede",
18521852
"metadata": {},
18531853
"source": [
1854-
"Then we can get the node positions to input them to the nichesphere **colocNW** function through the **pos** parameter"
1854+
"Then we can get the node positions to input them to the NicheSphere **colocNW** function through the **pos** parameter"
18551855
]
18561856
},
18571857
{
@@ -2242,7 +2242,7 @@
22422242
"id": "a1ef977c-ac57-4131-8e2a-92a5e42bd69e",
22432243
"metadata": {},
22442244
"source": [
2245-
"For further analysis, like differential communication: https://nichesphere.readthedocs.io/en/latest/notebooks/Nichesphere_tutorial_MIvisium_comm.html \n",
2245+
"For further analysis, like differential communication: https://nichesphere.readthedocs.io/en/latest/tutorials.html \n",
22462246
"\n",
22472247
", we will need the correspondence data between cell pairs and niche pairs"
22482248
]

docs/notebooks/Nichesphere_tutorial_MIvisium_comm.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@
77
"tags": []
88
},
99
"source": [
10-
"# Nichesphere differential communication tutorial"
10+
"# NicheSphere differential communication tutorial"
1111
]
1212
},
1313
{
1414
"cell_type": "markdown",
1515
"id": "43f6b026-a482-4bb1-92f8-47ac2cfbbbbe",
1616
"metadata": {},
1717
"source": [
18-
"Nichesphere also offers the possibility to look at localized process based differential cell - cell communication based on Ligand-Receptor pairs expression data, such as results from LIANA and CrossTalkeR(Nagai et. al., 2021). This improves the interpretability of cell communication analysis as we will find changes in biological processes related to the changes in physical cell interactions. For this tutorial, we will use our self compiled database which classifies ligands according to extracellular matrix (ECM) or immune cell recruitment related processes: https://github.com/CostaLab/Nichesphere/tree/main/nichesphere/db"
18+
"NicheSphere also offers the possibility to look at localized process based differential cell - cell communication based on Ligand-Receptor pairs expression data, such as results from LIANA and CrossTalkeR (Nagai et. al., 2021). This improves the interpretability of cell communication analysis as we will find changes in biological processes related to the changes in physical cell interactions. For this tutorial, we will use our self compiled database which classifies ligands according to extracellular matrix (ECM) or immune cell recruitment related processes: https://github.com/CostaLab/NicheSphere/tree/main/db"
1919
]
2020
},
2121
{
@@ -74,7 +74,7 @@
7474
"id": "dd39150c-a214-4b87-90bf-dbdec2b0b565",
7575
"metadata": {},
7676
"source": [
77-
"One of the advantages of Nichesphere is that it allows process based localized differential communication testing by looking at changes in LR interactions involved in specific processes between niches. To do this, we will need the correspondence data between cell type pairs and niche pairs, which we got from the **differential co-localization analysis**. You can check the differential co-localization tutorial for more details: https://nichesphere.readthedocs.io/en/latest/notebooks/Nichesphere_tutorial_MIvisium_coloc.html "
77+
"One of the advantages of NicheSphere is that it allows process based localized differential communication testing by looking at changes in LR interactions involved in specific processes between niches. To do this, we will need the correspondence data between cell type pairs and niche pairs, which we got from the **differential co-localization analysis**. You can check the differential co-localization tutorial for more details: https://nichesphere.readthedocs.io/en/latest/tutorials.html"
7878
]
7979
},
8080
{
@@ -601,7 +601,7 @@
601601
"id": "7952fa4f-03fd-4cd3-a00d-ff878d670e2f",
602602
"metadata": {},
603603
"source": [
604-
"Nichesphere is suited to work with CrossTalkeR output tables which contain columns called **cellpair**, indicating the cell types involved in an interaction separated by '@'; and **allpair**, indicating cell types, ligand and receptor involved. Additionally, input tables for Nichesphere should contain columns indicating the **ligand** (gene_A), **receptor** (gene_B) and **communication score** (MeanLR). The names for these last 3 columns can be indicated in Nichesphere functions."
604+
"NicheSphere is suited to work with CrossTalkeR output tables which contain columns called **cellpair**, indicating the cell types involved in an interaction separated by '@'; and **allpair**, indicating cell types, ligand and receptor involved. Additionally, input tables for NicheSphere should contain columns indicating the **ligand** (gene_A), **receptor** (gene_B) and **communication score** (MeanLR). The names for these last 3 columns can be indicated in NicheSphere functions."
605605
]
606606
},
607607
{
@@ -1227,7 +1227,7 @@
12271227
"id": "b75e023e-4593-40be-9800-60cb0a0b1140",
12281228
"metadata": {},
12291229
"source": [
1230-
"And now we can **plot differential cell communication** scores per process on the edges of the co-localization network using the **catNW** function from Nichesphere, whose parameters are quite similar to the ones of the **colocMW** function"
1230+
"And now we can **plot differential cell communication** scores per process on the edges of the co-localization network using the **catNW** function from NicheSphere, whose parameters are quite similar to the ones of the **colocMW** function"
12311231
]
12321232
},
12331233
{

docs/notebooks/Nichesphere_tutorial_MIvisium_preprocessing.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
"id": "ecc6a985-29a7-44e4-8f27-c6a8883f3a41",
66
"metadata": {},
77
"source": [
8-
"# Nichesphere data preprocessing tutorial\n",
8+
"# NicheSphere data preprocessing tutorial\n",
99
"\n",
10-
"Nichesphere is an sc-verse compatible Python library which allows the user to find differentially co-localized cellular niches and biological processes involved in their interactions based on cell type pairs co-localization probabilities in different conditions. Cell type pair co-localization probabilities are obtained in different ways: from deconvoluted Visium 10x / PIC-seq data (probabilities of finding each cell type in each spot / multiplet), or counting cell boundaries overlaps for each cell type pair in single cell spatial data (MERFISH , CODEX ...). This is addressed in the differential co-localization tutorial.\n",
10+
"NicheSphere is an sc-verse compatible Python library which allows the user to find differentially co-localized cellular niches and biological processes involved in their interactions based on cell type pairs co-localization probabilities in different conditions. Cell type pair co-localization probabilities are obtained in different ways: from deconvoluted Visium 10x / PIC-seq data (probabilities of finding each cell type in each spot / multiplet), or counting cell boundaries overlaps for each cell type pair in single cell spatial data (MERFISH , CODEX ...). This is addressed in the differential co-localization tutorial.\n",
1111
"\n",
12-
"Nichesphere also offers the possibility to look at localized differential cell - cell communication based on Ligand-Receptor pairs expression data, such as results from CrossTalkeR [ref]. This is addressed in the localized differential communication tutorial.\n",
12+
"NicheSphere also offers the possibility to look at localized differential cell - cell communication based on Ligand-Receptor pairs expression data. This is addressed in the localized differential communication tutorial.\n",
1313
"\n",
1414
"This tutorial focuses on the data **pre-processing** needed before doing the differential co-localization and localized process based differential communication analyses. "
1515
]
@@ -158,7 +158,7 @@
158158
"source": [
159159
"In this case, we will get cell type co-localization probabilities from **deconvoluted Visium** data (Cell type probabilities per spot): \n",
160160
"\n",
161-
"In a previous step, we used MOSCOT(Klein et. al., 2025) to deconvolute cell subtypes in visium slices from the same 23 samples , getting matrices of probabilities of each cell being in each spot. Now we will get cell type probabilities per spot summing the probabilities of cells of the same kind in each spot; thus getting cell type probability matrices for all spots per sample. This can be done with the **get_spot_ct_props** function from Nichesphere. As an example, we will do this for two samples: control sample **control_P1** and ischemic sample **GT_IZ_P9**"
161+
"In a previous step, we used MOSCOT(Klein et. al., 2025) to deconvolute cell subtypes in visium slices from the same 23 samples , getting matrices of probabilities of each cell being in each spot. Now we will get cell type probabilities per spot summing the probabilities of cells of the same kind in each spot; thus getting cell type probability matrices for all spots per sample. This can be done with the **get_spot_ct_props** function from NicheSphere. As an example, we will do this for two samples: control sample **control_P1** and ischemic sample **GT_IZ_P9**"
162162
]
163163
},
164164
{
@@ -1775,7 +1775,7 @@
17751775
"source": [
17761776
"## 4. For differential communication\n",
17771777
"\n",
1778-
"Nichesphere is suited to work with CrossTalkeR output tables which contain columns called **cellpair**, indicating the cell types involved in an interaction separated by '@'; and **allpair**, indicating cell types, ligand and receptor involved. Additionally, input tables for Nichesphere should contain columns indicating the **ligand** (gene_A), **receptor** (gene_B) and **communication score** (MeanLR). The names for these last 3 columns can be indicated in Nichesphere functions.\n",
1778+
"NicheSphere is suited to work with CrossTalkeR output tables which contain columns called **cellpair**, indicating the cell types involved in an interaction separated by '@'; and **allpair**, indicating cell types, ligand and receptor involved. Additionally, input tables for NicheSphere should contain columns indicating the **ligand** (gene_A), **receptor** (gene_B) and **communication score** (MeanLR). The names for these last 3 columns can be indicated in NicheSphere functions.\n",
17791779
"\n",
17801780
"The following tables come from a CrossTalkeR run comparing **myogenic** and **ischemic** samples. They are the condition specific tables in the **LR_data_final** object:"
17811781
]

0 commit comments

Comments
 (0)