Commit b4ffa113 authored by Bagueneau Mathias's avatar Bagueneau Mathias
Browse files

- Début de rédaction du ReadMe

parent dbe03eca
# Shiny SChnurR # ~ Shiny SChnurR
![](https://zupimages.net/up/19/17/rcn0.png) ![](https://zupimages.net/up/19/17/rcn0.png)
</br>
> **[Link of the tool][Link of the tool]**
**Table of Contents**
[TOC] # - Installation
# Installation
To use Shiny SChnurR, you first need to :
1. Install [R][R], version 3.5 or greater
2. Install some packages (*cf Required Packages part* ), like **Shiny**
3. Download all the files of this project
Hello
# Tutorial
Then, you simply need to launch R and this command :
```r
shiny::runApp('/my/path/to/my/folder/which/contain/all/the/files')
```
The *rds files used must have been made with the pipeline available at this adress :
## Required Packages
Here the list of the required packages for Shiny SChnurR :
* [shiny][shiny]
* shinythemes
* [Seurat][Seurat] : **The version 3 is required !**
* [sctransform][sctransform]
* dplyr
* ggplot2
* viridis
* shinyjs
* stringr
* plotly
* BiocManager
* shinydashboard
* shinyjs
* DT
* RColorBrewer
* MAST
* data.table
* clusterProfiler
* org.Hs.eg.db
# - Tutorial
Shiny SChnurR is a visualisation tool. Many options are available into the different pages.
Hello
## Visualisation Page ## Visualisation Page
Hey ! Redaction in progress...
## HeatMap Page ## HeatMap Page
Hello Redaction in progress...
## Genes Page ## Genes Page
Hello Redaction in progress...
## Compare Page
## Compare Page
Hello Redaction in progress...
## Pipeline Page ## Pipeline Page
Redaction in progress...
Hello
---- ----
[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"
Supports Markdown
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