Add installation instructions to the README.

neurogenomics · Apr 16, 2024 · b4dd117 · b4dd117
1 parent f84dbff
commit b4dd117
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -8,3 +8,14 @@ output: github_document
 ## MotifStats
 
 `MotifStats` is an R package for calculating metrics that quantify the relationship between peaks and motifs.
+
+## Installation
+
+`MotifStats` is available through GitHub. It can be installed using the following commands.
+
+```R
+if(!require("remotes")) install.packages("remotes")
+remotes::install_github("neurogenomics/MotifStats")
+```
+
+`MotifStats` lists [MEME suite](https://meme-suite.org/meme/index.html) as a system dependency. Directions for installation can be found [here](https://www.bioconductor.org/packages/release/bioc/vignettes/memes/inst/doc/install_guide.html).
diff --git a/README.md b/README.md
@@ -16,3 +16,18 @@ Authors: <i>Thomas Roberts</i>
 
 `MotifStats` is an R package for calculating metrics that quantify the
 relationship between peaks and motifs.
+
+## Installation
+
+`MotifStats` is available through GitHub. It can be installed using the
+following commands.
+
+``` r
+if(!require("remotes")) install.packages("remotes")
+remotes::install_github("neurogenomics/MotifStats")
+```
+
+`MotifStats` requires [MEME
+suite](https://meme-suite.org/meme/index.html) as a system dependency.
+Directions for installation can be found
+[here](https://www.bioconductor.org/packages/release/bioc/vignettes/memes/inst/doc/install_guide.html).