Skip to content

Commit

Permalink
suggested changes to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
campagnola authored Apr 12, 2022
1 parent f870c30 commit 6ddfa11
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,32 @@ R functions for gene selection and analysis of mFISH data

mfishtools includes many functions that are used for analysis of data for the CZI SpaceTx project, and mostly relies on correlation-based analysis with filtering. *This library is still in beta testing and may be buggy. Community involvement is encouraged through both issues and pull requests.*

Install using:
```
# Quickly, but without the vignettes:
devtools::install_github("AllenInstitute/mfishtools")
# More slowly, but with the vignettes:
devtools::install_github("AllenInstitute/mfishtools", build_opts = c("--no-resave-data", "--no-manual"))
```
## Installation

Note that a couple of libraries need to be installed prior to running the vignettes:
Install prerequisites:
```
install.packages("devtools")
devtools::install_github("AllenInstitute/scrattch.vis")
devtools::install_github("AllenInstitute/tasic2016data")
```

Note that some people may need to manually install the `GO.db` library:
Note that some people may need to manually install the `GO.db` and `WGCNA` libraries as well:
```
install.packages("BiocManager")
BiocManager::install("GO.db")
BiocManager::install("WGCNA")
```

Install `mfishtools` using:
```
# Quickly, but without the vignettes:
devtools::install_github("AllenInstitute/mfishtools")
# More slowly, but with the vignettes:
devtools::install_github("AllenInstitute/mfishtools", build_opts = c("--no-resave-data", "--no-manual"))
```


## Library use cases

There are two primary use cases for this libary:
Expand Down

0 comments on commit 6ddfa11

Please sign in to comment.