From c7a8c6a8815d62d4dfa61c7d8f84935d23259d15 Mon Sep 17 00:00:00 2001 From: Marijn Date: Thu, 26 Mar 2020 14:12:27 +0100 Subject: [PATCH] Updated Readme --- README.md | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index fc1ce65..fb7d5ff 100644 --- a/README.md +++ b/README.md @@ -2,21 +2,10 @@ FastCAR is an R package to remove ambient RNA from cells in droplet based single cell RNA sequencing data. -## Getting Started -These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. +### Installation -### Prerequisites - -What things you need to install the software and how to install them - -``` -Give examples -``` - -### Installing - -FastCAR can be install from git with the following command. +FastCAR can be installed from git with the following command. ``` devtools::install_git("https://git.web.rug.nl/P278949/FastCAR") @@ -105,3 +94,7 @@ write.corrected.matrix(cellMatrix, correctedMatrixFolder, ambientProfile) This project is licensed under the GPL-3 License - see the [LICENSE.md](LICENSE.md) file for details +## Changelog + +### v0.1 +First fully working version of the R package