Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Xiaojieqiu authored Dec 5, 2018
1 parent 895068a commit f259948
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,20 @@ Single-cell transcriptome sequencing now routinely samples thousands of cells, p
Note that this is still an alpha version of **Scribe**. Stable version of Scribe will be released when it is ready. Until then, please use **Scribe** with caution. We welcome any bugs reports of **Scribe** and any comments, suggestions regarding to our manuscript (See below). You can install this alpha version of **Scribe** via the following steps:

```sh
# first clone the github repo with `git clone git@github.com:cole-trapnell-lab/Scribe.git`
# then cd to the directory where the cloned github repo located
# then run the following command in the terminal:
# Scribe depends on RANNinf package, first clone the RANNinf package `git clone https://github.com/cole-trapnell-lab/RANNinf`
# You can then cd to the parent folder of `RANNinf` and build and install it with the following command in the terminal:
R CMD build RANNinf # this build the RANNinf package and produce a file RANNinf_2.5.0.99.tar.gz
R CMD install RANNinf_2.5.0.99.tar.gz # install the built RANNinf package, similar to the RANN package but the infinity norm is used
# then clone the github repo with `git clone git@github.com:cole-trapnell-lab/Scribe.git`
# then cd to the directory where the cloned github repo located
R CMD install Scribe_0.1.tar.gz # install the built Scribe package. You may need to first install other required packages before successfully install Scribe
```

Package dependcies issues may incur when you try to install RANNinf or Scribe, you can easily install those packages from CRAN or bioconductor.
On Mac OS, you may confronted the error (*clang: error: linker command failed with exit code 1 (use -v to see invocation)*) wheny you try to install **Scribe**. That is because Scribe depends on gfortran and your system should use the updated gfortran. See https://thecoatlessprofessor.com/programming/rcpp-rcpparmadillo-and-os-x-mavericks--lgfortran-and--lquadmath-error/.

## Citation
Xiaojie Qiu, Arman Rahimzamani, Li Wang, Qi Mao, Timothy Durham, Jose L McFaline-Figueroa, Lauren Saunders, Cole Trapnell, Sreeram Kannan (2018): Towards inferring causal gene regulatory networks from single cell expression measurements. BioRxiv

biorxiv link: https://www.biorxiv.org/content/early/2018/09/25/426981

twitter link: https://twitter.com/coletrapnell/status/1044986820520435712
twitter link: https://twitter.com/coletrapnell/status/1044986820520435712

0 comments on commit f259948

Please sign in to comment.