README.md 4.76 KB
Newer Older
1
# ~ Shiny SChnurR
Jean-Baptiste ALBERGE's avatar
Jean-Baptiste ALBERGE committed
2

Bagueneau Mathias's avatar
Bagueneau Mathias committed
3
![](https://zupimages.net/up/19/18/zpld.png)
4

5
</br>
6

Bagueneau Mathias's avatar
Bagueneau Mathias committed
7
**Direct Link of the Tool :** https://shiny-bird.univ-nantes.fr/jbalberge/schnurr/
Jean-Baptiste ALBERGE's avatar
Jean-Baptiste ALBERGE committed
8

Bagueneau Mathias's avatar
Bagueneau Mathias committed
9
10
11
12
# - Introduction

Shiny SChnurR is a visualisation tool for single-cell RNA-seq analysis developped in R Shiny.

Jean-Baptiste ALBERGE's avatar
Jean-Baptiste ALBERGE committed
13

14
# - Installation
Jean-Baptiste ALBERGE's avatar
Jean-Baptiste ALBERGE committed
15

16
To use Shiny SChnurR, you first need to :
Bagueneau Mathias's avatar
Bagueneau Mathias committed
17

18
19
1. Install [R][R], version 3.6 (Planting of a Tree) or greater.
2. Install some packages with the script **install.R** (*cf Required Packages part* ).
Bagueneau Mathias's avatar
Bagueneau Mathias committed
20
3. Download all files of this project, or clone it.
Bagueneau Mathias's avatar
Bagueneau Mathias committed
21
22


23
24
25
26
27
Then, you simply need to launch R and this command :
```r
shiny::runApp('/my/path/to/my/folder/which/contain/all/the/files')
```

Bagueneau Mathias's avatar
Bagueneau Mathias committed
28
29
The .rds files used must have been made with the analysis pipeline available at this adress : 
https://gitlab.univ-nantes.fr/E176261N/singlecell
30
31
32
33
34

## Required Packages

Here the list of the required packages for Shiny SChnurR :

Bagueneau Mathias's avatar
Bagueneau Mathias committed
35
* [Shiny][Shiny]
36
* [Seurat][Seurat]
Bagueneau Mathias's avatar
Bagueneau Mathias committed
37
* [SCTransform][Sctransform]
38
* shinythemes
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
* dplyr
* ggplot2
* viridis
* shinyjs
* stringr
* plotly
* BiocManager
* shinydashboard
* shinyjs
* DT
* RColorBrewer
* MAST
* data.table
* clusterProfiler
* org.Hs.eg.db
Bagueneau Mathias's avatar
Bagueneau Mathias committed
54
55
* tools

56
All of this packages are installed with the provided script **install.R** and are up-to-date.
57
58
59

# - Tutorial

Bagueneau Mathias's avatar
Bagueneau Mathias committed
60
Many options are available into the different pages.
Bagueneau Mathias's avatar
Bagueneau Mathias committed
61
62
63

## Visualisation Page

Bagueneau Mathias's avatar
Bagueneau Mathias committed
64
65
66
67
68
69
70
71
72
73
74
75
76
Once you launch the app, the first page is the Visualisation page.
You first need to upload a .rds file, or choose one already provided as example.

Then, many information are provided :

* Some files information, with genes and cells number, and the assay used.

* Two graphs for the visualisation.

* A data table with some pre-calculated markers.

The first graph allows you to visualise by all the factors (resolution, idents, ...) of your file.
The second one is for the features or data (all the genes repartitions, scores, ...).
77
The two graphs could be controlled with the panel made for. You have two graph modes : t-SNE or UMAP, and clusters information for every factors.
Bagueneau Mathias's avatar
Bagueneau Mathias committed
78
On the graphs, you could also select some cells, and have the percentage of your selection by the total cell number.
Bagueneau Mathias's avatar
Bagueneau Mathias committed
79

Bagueneau Mathias's avatar
Bagueneau Mathias committed
80
81
82
83
The data table under the graphs is pre-calculated depending the selected factor.
It shows all significant markers, calculated with the test MAST. You could affine your marker research with the filters.

All of the outputs are exportable : in .svg for the graphs and in .csv for the table.
Bagueneau Mathias's avatar
Bagueneau Mathias committed
84
85
86

## HeatMap Page

Bagueneau Mathias's avatar
Bagueneau Mathias committed
87
88
89
90
The HeatMap page allows you to do a HeatMap with many parameters.
You could choose a factor and the number of top genes you want to be shown.

The HeatMap also use the pre-calculated markers for each factors (like the data table from the visualisation page).
Bagueneau Mathias's avatar
Bagueneau Mathias committed
91

92
The HeatMap is exportable in .png.
Bagueneau Mathias's avatar
Bagueneau Mathias committed
93
94
95

## Genes Page

96
97
98
99
100
101
102
103
104
105
The Genes page allows you to do a Gene Ontology and have information about genes.
You have to choose a factor, group(s) of it, and ontology. Three type of ontology are available : Biological Process, Molecular Function and Cellular Component.

Then you will have a graph (you can also change the graph mode), and two tables.
The first table gives you the list of the genes present in your selection.
The second one gives you the ontology.

The Gene Ontology also use the pre-calculated markers for each factors (like the data table from the visualisation page and the HeatMap).

All of the outputs are exportable : in .png for the graph and in .csv for the tables.
Bagueneau Mathias's avatar
Bagueneau Mathias committed
106

107
## Compare Page
Bagueneau Mathias's avatar
Bagueneau Mathias committed
108

Bagueneau Mathias's avatar
Bagueneau Mathias committed
109
110
111
In this page, you could compare groups from factors with each other.
You could choose multiple groups, and also add a second factor to filter with.

112
Then you could Find the significant markers of your selection, or also do a Gene Ontology like in the Genes page (but here, the markers are calculated before the ontology).
Bagueneau Mathias's avatar
Bagueneau Mathias committed
113
114
115
116
117
Be carefull to not select redondant cells.

Like the Visualisation page, you have a Control panel to change some parameters to the graphs (like graph mode, point size, ...) and choose what you want to see (factors, features, ...).

All of the outputs are exportable : in .svg for the graphs and in .csv for the table.
Bagueneau Mathias's avatar
Bagueneau Mathias committed
118
119
120

## Pipeline Page

Bagueneau Mathias's avatar
Bagueneau Mathias committed
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
This page presents the different tools used in the analysis pipeline.


_____________________________

### About

**- Shiny SChnurR -**

Centre de Recherche en Cancérologie et Immunologie Nantes-Angers
UMR1232, CNRS ERL6001
IRS-UN - 8 Quai Moncousu - 44007 Nantes

**Equipe 11** 'Oncogénomique intégrative de la genèse et de la progression du Myélome Multiple'

*Jean-Baptiste Alberge, Jonathan Cruard, Mathias Bagueneau*
Bagueneau Mathias's avatar
Bagueneau Mathias committed
137
138

----
139
140
141
142
143
144

[R]: https://www.r-project.org/ "R"
[Seurat]: http://https://satijalab.org/seurat/install.html "Seurat"
[sctransform]: https://rawgit.com/ChristophH/sctransform/master/inst/doc/seurat.html "sctransform"
[Link of the tool]: https://shiny-bird.univ-nantes.fr/jbalberge/schnurr/ "Link of the tool"
[shiny]: https://shiny.rstudio.com/ "shiny"