Browse code

Update Readme

Add installation instructions for R3.5 users and backward compatibility for results generated by older celda versions.

Zhe Wang authored on 11/04/2019 18:58:52 • GitHub committed on 11/04/2019 18:58:52
Showing 1 changed files

... ...
@@ -13,12 +13,24 @@
13 13
 
14 14
 ## Installation Instructions
15 15
 
16
-To install the most recent release of celda via devtools:
16
+To install the most recent release of celda (R >= 3.6) via devtools:
17 17
 ```
18 18
 library(devtools)
19 19
 install_github("campbio/celda")
20 20
 ```
21 21
 
22
+For R3.5 users, please install from the R_3_5 branch:
23
+```
24
+library(devtools)
25
+install_github("campbio/celda@R_3_5")
26
+```
27
+
28
+For backward compatibility with results (`celda_CG` and `celda_list` objects) generated from older versions of celda, please install from the mirror branch 20190409_master:
29
+```
30
+library(devtools)
31
+install_github("campbio/celda@20190409_master")
32
+```
33
+
22 34
 **NOTE** On OSX, `devtools::install_github()` requires installation of **libgit2.** This can be installed via homebrew:
23 35
 ```
24 36
 brew install libgit2