Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jfouyang committed Mar 17, 2021
1 parent cc08467 commit 1903d39
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 19 deletions.
48 changes: 29 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,32 +13,42 @@ respectively.

Key features of `ShinyCell` include:

- Written in R and uses the Shiny package, allowing for easy sharing on online
platforms e.g. [shinyapps.io](https://www.shinyapps.io/) and Amazon Web
Services (AWS) or be hosted via Shiny Server
1. Written in R and uses the Shiny package, allowing for easy sharing on online
platforms e.g. [shinyapps.io](https://www.shinyapps.io/) and Amazon Web
Services (AWS) or be hosted via Shiny Server

- Supports all of the major single-cell data formats (h5ad / loom / Seurat /
SingleCellExperiment) and we also include a simple tutorial to process
plain-text gene expression matrices
2. Supports all of the major single-cell data formats (h5ad / loom / Seurat /
SingleCellExperiment) and we also include a simple tutorial to process
plain-text gene expression matrices

- Web interface have low memory footprint due to the use of hdf5 file system
to store the gene expression. Only the expression of genes that are plotted
are loaded into memory
3. Web interface have low memory footprint due to the use of hdf5 file system
to store the gene expression. Only the expression of genes that are plotted
are loaded into memory

- Inclusion of less common single-cell visualisations, namely coexpression
plots and proportion plots that provide additional information on top of
low-dimensional embeddings
4. Inclusion of less common single-cell visualisations, namely coexpression
plots and proportion plots that provide additional information on top of
low-dimensional embeddings

- Users can export visualisations as PDF or PNG images for presentation or
publication use
5. Users can export visualisations as PDF or PNG images for presentation or
publication use

- Ability to include multiple single-cell datasets into a single Shiny web app
6. Ability to include multiple single-cell datasets into a single Shiny web app

- It is easy to use and customise aethetsics e.g. label names and colour
palettes. In the simplest form, ShinyCell can convert an input single-cell
data into a Shiny app with five lines of code
(see [Quick Start Guide](#quick-start-guide))
7. It is easy to use and customise aethetsics e.g. label names and colour
palettes. In the simplest form, ShinyCell can convert an input single-cell
data into a Shiny app with five lines of code
(see [Quick Start Guide](#quick-start-guide))

We also compared ShinyCell with nine other popular scRNA-seq visualisation
tools, which further highlights the key features of `ShinyCell`. For a more
detailed description, see the
[Supplementary Information](docs/OuyangEtAl_Shinycell_SuppInfo.pdf).

![](images/comparison.png)



# Table of Contents and Additional Tutorials
This readme is broken down into the following sections:

- [Installation](#installation) on how to install `ShinyCell`
Expand Down
Binary file added docs/OuyangEtAl_Shinycell_SuppInfo.pdf
Binary file not shown.
Binary file added images/comparison.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1903d39

Please sign in to comment.