diff --git a/README.md b/README.md index ad4c5a7a..1690f0d5 100755 --- a/README.md +++ b/README.md @@ -3,38 +3,41 @@ # Cerebro + + **Table of Contents** -- [Introduction to the Cerebro interface](#introduction-to-the-cerebro-interface) - - [Load data](#load-data) - - [Overview](#overview) - - [Samples](#samples) - - [Clusters](#clusters) - - [Most expressed genes](#most-expressed-genes) - - [Marker genes](#marker-genes) - - [Enriched pathways](#enriched-pathways) - - [Gene expression](#gene-expression) - - [Gene set expression](#gene-set-expression) - - [Trajectory](#trajectory) - - [Gene ID conversion](#gene-id-conversion) - - [Analysis info](#analysis-info) -- [Motivation](#motivation) -- [Installation](#installation) - - [Details: `cerebroApp` R package](#details-cerebroapp-r-package) - - [Details: `romanhaa/cerebro` Docker container](#details-romanhaacerebro-docker-container) -- [Example data sets](#example-data-sets) -- [Conversion of other single cell data formats](#conversion-of-other-single-cell-data-formats) -- [Technical notes](#technical-notes) -- [Building from source](#building-from-source) - - [On macOS](#on-macos) - - [On Windows](#on-windows) -- [Troubleshooting](#troubleshooting) -- [Credits](#credits) -- [Contribute](#contribute) -- [Citation](#citation) -- [License](#license) +- [Cerebro](#cerebro) + - [Introduction to the Cerebro interface](#introduction-to-the-cerebro-interface) + - [Load data](#load-data) + - [Overview](#overview) + - [Samples](#samples) + - [Clusters](#clusters) + - [Most expressed genes](#most-expressed-genes) + - [Marker genes](#marker-genes) + - [Enriched pathways](#enriched-pathways) + - [Gene expression](#gene-expression) + - [Gene set expression](#gene-set-expression) + - [Trajectory](#trajectory) + - [Gene ID conversion](#gene-id-conversion) + - [Analysis info](#analysis-info) + - [Motivation](#motivation) + - [Installation](#installation) + - [Details: `cerebroApp` R package](#details-cerebroapp-r-package) + - [Details: `romanhaa/cerebro` Docker container](#details-romanhaacerebro-docker-container) + - [Example data sets](#example-data-sets) + - [Conversion of other single cell data formats](#conversion-of-other-single-cell-data-formats) + - [Technical notes](#technical-notes) + - [Building from source](#building-from-source) + - [On macOS](#on-macos) + - [On Windows](#on-windows) + - [Troubleshooting](#troubleshooting) + - [Credits](#credits) + - [Contribute](#contribute) + - [Citation](#citation) + - [License](#license) diff --git a/README_for_biologists.md b/README_for_biologists.md index e8ce512e..beeef0a2 100644 --- a/README_for_biologists.md +++ b/README_for_biologists.md @@ -1,5 +1,7 @@ # Introduction to Cerebro + + This article is meant to give an introduction to Cerebro for people who don't have any bioinformatic skills. Maybe you are an experimental biologists who performed a scRNA-seq experiment and the computational biologists who analysed the data for you gave you a file and told you to load it into Cerebro. And, maybe, he/she didn't tell you what Cerebro is and what it can be used for. diff --git a/logo_Cerebro.png b/logo_Cerebro.png new file mode 100644 index 00000000..c61f2210 Binary files /dev/null and b/logo_Cerebro.png differ