Skip to content

Commit

Permalink
Updated tutorial vignette.
Browse files Browse the repository at this point in the history
  • Loading branch information
PratibhaPanwar committed Oct 29, 2024
1 parent ef1d5fd commit 39ba742
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
Empty file added .Rhistory
Empty file.
17 changes: 8 additions & 9 deletions vignettes/clustSIGNAL_tutorial.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,11 @@ title: "clustSIGNAL tutorial"
author:
- Pratibha Panwar, Boyi Guo, Haowen Zhou, Stephanie Hicks, Shila Ghazanfar
date: "`r Sys.Date()`"
output:
BiocStyle::html_document:
toc_float: true
BiocStyle::pdf_document: default
package: clustSIGNAL
vignette: |
%\VignetteEngine{knitr::rmarkdown}
%\VignetteIndexEntry{clustSIGNAL tutorial}
%\VignetteEncoding{UTF-8}
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{clustSIGNAL tutorial}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---

```{r, include = FALSE}
Expand All @@ -21,6 +17,9 @@ knitr::opts_chunk$set(
)
```

## Section


# Overview

In this vignette, we will demonstrate how to perform spatially-resolved clustering with clustSIGNAL. Following this, we will explore the clusters using pre-defined metrics like adjusted rand index (ARI), normalised mutual information (NMI), and average silhouette width, as well as spatial plots. We will also display the use of entropy measures generated as a by-product of clustSIGNAL process in understanding the tissue structure of a sample. In the end, we will also explore multisample analysis with clustSIGNAL.
Expand Down

0 comments on commit 39ba742

Please sign in to comment.