Skip to content

Commit 7f6dfa1

Browse files
committed
update readme
1 parent 9652dce commit 7f6dfa1

File tree

2 files changed

+23
-17
lines changed

2 files changed

+23
-17
lines changed

README.Rmd

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ rmarkdown::render("README.Rmd",output_format = "md_document")
2424

2525
We describe the NicheNet algorithm in the following paper: [NicheNet: modeling intercellular communication by linking ligands to target genes](https://www.nature.com/articles/s41592-019-0667-5).
2626

27-
Bonnardel, T'Jonck et al. (2019) already used NicheNet to predict upstream niche signals driving Kupffer cell differentiation [Stellate Cells, Hepatocytes, and Endothelial Cells Imprint the Kupffer Cell Identity on Monocytes Colonizing the Liver Macrophage Niche](https://www.cell.com/immunity/fulltext/S1074-7613(19)30368-1).
2827

2928
### Major updates (20-06-2023)!
3029

@@ -64,11 +63,13 @@ Specific functionalities of this package include:
6463
Moreover, we provide instructions on how to make intuitive visualizations of the main predictions (e.g., via circos plots as shown here below).
6564

6665
<br><br>
67-
![](vignettes/circos_plot_adapted.jpg) functions to prioritize ligands not only based on the ligand activity, but also on the ligand and receptor expression, cell type specificity, and condition specificity. This is similar to the criteria used in Differential NicheNet and MultiNicheNet. See the Prioritizing ligands based on expression values vignette for more information.
68-
Due to this more generalizable prioritization scheme, we will no longer provide support for Differential NicheNet.
69-
We included code for making a ligand-receptor-target circos plot in the Circos plot visualization vignette.
66+
![](vignettes/circos_plot_adapted.jpg)
7067

71-
Introduction to NicheNet dependencies) from github with:
68+
## Installation of nichenetr
69+
70+
Installation typically takes a few minutes, depending on the number of
71+
dependencies that has already been installed on your pc. You can install
72+
nichenetr (and required dependencies) from github with:
7273

7374
```{r gh-installation, eval = FALSE}
7475
# install.packages("devtools")
@@ -109,8 +110,8 @@ People interested in building own models or benchmark own models against NicheNe
109110
* [Parameter optimization via mlrMBO](vignettes/parameter_optimization.md): `vignette("parameter_optimization", package="nichenetr")`
110111

111112

112-
**[Deprecated]**
113-
Instead of using Differential NicheNet, you may want to consider using the [general prioritization scheme]() instead.
113+
##### Deprecated vignettes
114+
Differential NicheNet has been deprecated; you may want to consider using the [general prioritization scheme](vignettes/seurat_steps_prioritization.md) instead.
114115

115116
* [Differential NicheNet analysis between niches of interest](vignettes/differential_nichenet.md):`vignette("differential_nichenet", package="nichenetr")`
116117
* [Differential NicheNet analysis between conditions of interest](vignettes/differential_nichenet_pEMT.md):`vignette("differential_nichenet_pEMT", package="nichenetr")`
@@ -125,12 +126,14 @@ Check the FAQ page at [FAQ NicheNet](vignettes/faq.md): `vignette("faq", packag
125126

126127
## Previous updates
127128

128-
12-01-2022: In the Liver Atlas paper from Guilliams et al.: [Spatial proteogenomics reveals distinct and evolutionarily conserved hepatic macrophage niches](https://www.sciencedirect.com/science/article/pii/S0092867421014811), we used Differential NicheNet, an extension to the default NicheNet algorithm. **Differential NicheNet** can be used to compare cell-cell interactions between different niches and better predict niche-specific ligand-receptor (L-R) pairs. It was used in that paper to predict ligand-receptor pairs specific for the Kupffer cell niche in mouse and human.
129+
**12-01-2022:** In the Liver Atlas paper from Guilliams et al.: [Spatial proteogenomics reveals distinct and evolutionarily conserved hepatic macrophage niches](https://www.sciencedirect.com/science/article/pii/S0092867421014811), we used Differential NicheNet, an extension to the default NicheNet algorithm. **Differential NicheNet** can be used to compare cell-cell interactions between different niches and better predict niche-specific ligand-receptor (L-R) pairs. It was used in that paper to predict ligand-receptor pairs specific for the Kupffer cell niche in mouse and human.
129130

130131
The main difference between the classic NicheNet pipeline and the Differential NicheNet pipeline is that Differential NicheNet also uses the differential expression between the conditions/niches of the ligand-receptor pairs for prioritization in addition to the ligand activities. The classic NicheNet pipeline on the contrary uses only ligand acivity for prioritization (and shows differential expression only in visualizations).
131132

132133
So if you have data of multiple conditions or niches, and you want to include differential expression of the ligand-receptor pairs in the prioritization, we recommend you check out Differential NicheNet (update nichenetr to the 1.1.0 version). At the bottom of this page, you can find the links to two vignettes illustrating a Differential NicheNet analysis. We recommend these vignettes if you want to apply Differential NicheNet on your own data. If you want to see the code used for the analyses used in the Guilliams et al. paper, see https://github.com/saeyslab/NicheNet_LiverCellAtlas.
133134

135+
**15-10-2019:** Bonnardel, T'Jonck et al. used NicheNet to predict upstream niche signals driving Kupffer cell differentiation [Stellate Cells, Hepatocytes, and Endothelial Cells Imprint the Kupffer Cell Identity on Monocytes Colonizing the Liver Macrophage Niche](https://www.cell.com/immunity/fulltext/S1074-7613(19)30368-1).
136+
134137

135138
## References
136139

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,6 @@ We describe the NicheNet algorithm in the following paper: [NicheNet:
2828
modeling intercellular communication by linking ligands to target
2929
genes](https://www.nature.com/articles/s41592-019-0667-5).
3030

31-
Bonnardel, T’Jonck et al. (2019) already used NicheNet to predict
32-
upstream niche signals driving Kupffer cell differentiation [Stellate
33-
Cells, Hepatocytes, and Endothelial Cells Imprint the Kupffer Cell
34-
Identity on Monocytes Colonizing the Liver Macrophage
35-
Niche](https://www.cell.com/immunity/fulltext/S1074-7613(19)30368-1).
36-
3731
### Major updates (20-06-2023)!
3832

3933
- MultiNicheNet - a multi-sample, multi-condition extension of
@@ -203,8 +197,11 @@ NicheNet can read one of the following vignettes:
203197
mlrMBO](vignettes/parameter_optimization.md):
204198
`vignette("parameter_optimization", package="nichenetr")`
205199

206-
**\[Deprecated\]** Instead of using Differential NicheNet, you may want
207-
to consider using the [general prioritization scheme]() instead.
200+
##### Deprecated vignettes
201+
202+
Differential NicheNet has been deprecated; you may want to consider
203+
using the [general prioritization
204+
scheme](vignettes/seurat_steps_prioritization.md) instead.
208205

209206
- [Differential NicheNet analysis between niches of
210207
interest](vignettes/differential_nichenet.md):`vignette("differential_nichenet", package="nichenetr")`
@@ -227,7 +224,7 @@ Check the FAQ page at [FAQ NicheNet](vignettes/faq.md):
227224

228225
## Previous updates
229226

230-
12-01-2022: In the Liver Atlas paper from Guilliams et al.: [Spatial
227+
**12-01-2022:** In the Liver Atlas paper from Guilliams et al.: [Spatial
231228
proteogenomics reveals distinct and evolutionarily conserved hepatic
232229
macrophage
233230
niches](https://www.sciencedirect.com/science/article/pii/S0092867421014811),
@@ -256,6 +253,12 @@ NicheNet on your own data. If you want to see the code used for the
256253
analyses used in the Guilliams et al. paper, see
257254
<https://github.com/saeyslab/NicheNet_LiverCellAtlas>.
258255

256+
**15-10-2019:** Bonnardel, T’Jonck et al. used NicheNet to predict
257+
upstream niche signals driving Kupffer cell differentiation [Stellate
258+
Cells, Hepatocytes, and Endothelial Cells Imprint the Kupffer Cell
259+
Identity on Monocytes Colonizing the Liver Macrophage
260+
Niche](https://www.cell.com/immunity/fulltext/S1074-7613(19)30368-1).
261+
259262
## References
260263

261264
Browaeys, R., Saelens, W. & Saeys, Y. NicheNet: modeling intercellular

0 commit comments

Comments
 (0)