Skip to content

Commit 5ce47fb

Browse files
committed
Get started: remove tutorial content, add installation and article links
1 parent 65bf440 commit 5ce47fb

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

vignettes/multideconv.Rmd

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,37 @@ knitr::opts_chunk$set(
1818
)
1919
```
2020

21-
This tutorial demonstrates how to use the `multideconv` package and explains the main functions of the pipeline for deconvolving RNA-seq data.
21+
`multideconv` is an integrative pipeline for combining first- and second-generation cell type deconvolution methods from bulk RNA-seq data, as described in [Hurtado et al., 2025](https://www.biorxiv.org/content/10.1101/2025.04.29.651220v2.article-info).
2222

23-
```{r setup}
24-
library(multideconv)
23+
## Installation
24+
25+
To avoid GitHub API rate limit issues, set up a Personal Access Token (PAT) before installing:
26+
27+
```{r, eval=FALSE}
28+
# install.packages(c("usethis", "gitcreds"))
29+
usethis::create_github_token()
30+
gitcreds::gitcreds_set()
31+
```
32+
33+
Install `multideconv` from GitHub:
34+
35+
```{r, eval=FALSE}
36+
# install.packages("pak")
37+
pak::pkg_install("VeraPancaldiLab/multideconv")
2538
```
39+
40+
## Tutorials
41+
42+
Step-by-step tutorials are available in the **Articles** section of the navigation bar:
43+
44+
- **Deconvolution with default methods** — run first-generation deconvolution and access built-in signatures
45+
- **Single-cell deconvolution** — construct metacells and apply second-generation methods
46+
- **Pseudo-bulk profiles and benchmarking** — create pseudo-bulk data, generate custom signatures, and benchmark performance
47+
- **Cell type subgroup analysis** — derive cell-type subgroups and build a deconvolution dictionary
48+
- **Machine learning workflows** — use subgroup features in cross-validated ML models
49+
50+
## Citation
51+
52+
If you use `multideconv` in a scientific publication, please cite:
53+
54+
> Hurtado, M., Essabbar, A., Khajavi, L., & Pancaldi, V. (2025). *multideconv – Integrative pipeline for cell type deconvolution from bulk RNAseq using first and second generation methods.* bioRxiv. <https://doi.org/10.1101/2025.04.29.651220>

0 commit comments

Comments
 (0)