Commit 7afd3d4f authored by Bagueneau Mathias's avatar Bagueneau Mathias
Browse files

- ReadMe Update

parent 1f1e6aee
# ~ Shiny SChnurR
# Shiny SChnurR
![](https://zupimages.net/up/19/18/zpld.png)
<img src="https://zupimages.net/up/19/18/zpld.png" alt="Logo"
title="SChnurR logo" width="42" height="42" /> **Direct Link of the Tool :** https://shiny-bird.univ-nantes.fr/jbalberge/schnurr/
</br>
**Direct Link of the Tool :** https://shiny-bird.univ-nantes.fr/jbalberge/schnurr/
# - Introduction
## Introduction
Shiny SChnurR is a visualisation tool for single-cell RNA-seq analysis developped in R Shiny.
# - Installation
## Installation
To use Shiny SChnurR, you first need to :
......@@ -69,99 +66,22 @@ Here the list of the required packages for Shiny SChnurR :
All of this packages are installed with the provided script **install.R** and are up-to-date.
# - Tutorial
Many options are available into the different pages.
## Visualization Page
Once you launch the app, the first page is the Visualization 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 plots for the visualization.
* A data table with some pre-calculated markers.
The first plot allows you to visualise by all the class (resolution, idents, ...) of your file.
The second one is for the features or quantitative variables (all the genes repartitions, scores, ...).
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.
On the plots, you could also select some cells, and have the percentage of your selection by the total cell number.
The data table under the graphs is pre-calculated depending the selected class.
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 plots and in .csv for the table.
## Heatmap Page
The Heatmap page allows you to do a Heatmap with many parameters.
You could choose a class and the number of top genes you want to be shown.
The Heatmap also use the pre-calculated markers for each class (like the data table from the visualization page). If the markers are not pre-calculated, it will be done here but could take a while...
The Heatmap is exportable in .png.
## Genes Page
The Genes page allows you to do a Gene Ontology and have information about genes.
You have to choose a class, 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 visualization page and the Heatmap). If the markers are not pre-calculated, it will be done here but could take a while...
All of the outputs are exportable : in .png for the graph and in .csv for the tables.
## Compare Page
In this page, you could compare groups from class with each other.
You could choose multiple groups, and also add a second class to filter with.
Then you could Find the significant markers of your selection.
Be carefull to not select redondant cells.
After this, another option and two text areas appears. The text areas are filled with the top 30 genes upregulated from one condition against the other. These areas are writable (you can add or remove some genes).
Then you could do a gene ontology with these two lists.
The results are into two tables.
Like the Visualization 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 (class, features, ...).
You could also choose an ontology.
All of the outputs are exportable : in .svg for the plots and in .csv for the tables.
You could export the barcodes and the metadata of the selected cells, in .csv.
You could also export the selected cells as Seurat object in .rds.
## Grid Page
The Grid page allows a great visualization for genes plots.
In this page, you could choose many genes to visualize. Some presets are available to show genes plots depending a cell type, a pathway, ...
You could also change some parameters, like the graph mode or the number of columns you want.
The grid plot is exportable in .png.
## Pipeline Page
## Tutorial
This page presents the different tools used in the analysis pipeline.
Please refer to the Wiki to find some help about using the app.
_____________________________
### About
## About
**- Shiny SChnurR -**
** 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'
**Equipe 11** - Oncogénomique intégrative de la genèse et de la progression du Myélome Multiple
*Mathias Bagueneau, Jean-Baptiste Alberge, Jonathan Cruard*
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment