Commit 02060014 authored by velten-lab's avatar velten-lab
Browse files

Updated Readme

parent eede66f5
......@@ -2,10 +2,10 @@ To install from within R, you can use the `install_git` function from the `devto
```
install.packages("devtools")
devtools::install_git("https://git.embl.de/velten/rnamagnet/")
devtools::install_github("veltenlab/rnamagnet")
```
In case this fails, download the tar.gz archive, unpack to a directory of your choice (e.g. /path/to) and inside R run
In case this fails, download the zip archive from this website, unpack to a directory of your choice (e.g. /path/to) and inside R run
```
devtools::install_local("/path/to/rnamagnet_dir")
```
......@@ -14,8 +14,8 @@ devtools::install_local("/path/to/rnamagnet_dir")
The vignettes now require seurat v3, but the functions work both with seurat v2 and seurat v3 objects.
If you want to build the vignettes yourself or make the demo data from our manuscript avaialable, please proceed as follows:
If you want to build the vignettes yourself or make the data from our manuscript avaialable inside the package, please proceed as follows:
* Download and unpack the tar.gz archive, e.g. to /path/to
* Then download our data bundle (2GB, containing all 10x and LCM data) from https://www.dropbox.com/s/wbnqaebqi74j5ic/RNAMagnetDataBundle.zip
* Then download our data bundle (1GB, containing all 10x and LCM data) from https://www.dropbox.com/s/wbnqaebqi74j5ic/RNAMagnetDataBundle.zip
* Move the content of the data bundle to the data/ folder of the package, e.g. /path/to/rnamagnet_dir/data
* Then, run `devtools::install_local("/path/to/rnamagnet_dir")` or `devtools::install_local("/path/to/rnamagnet_dir", build_vignettes=T)`
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