update readme

jdreyf · Jul 31, 2023 · 5ca5f4a · 5ca5f4a
1 parent bdbadcc
commit 5ca5f4a
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: DirectionalMaxPTest
-Title: Applies the directional MaxP test for replication and mediation
-Version: 0.0.0.9001
+Title: Directional MaxP test for replication, mediation, & qualitative interactions
+Version: 0.0.0.9002
 Authors@R: 
     person(given = "Jonathan",
            family = "Dreyfuss",

diff --git a/README.md b/README.md
@@ -2,4 +2,17 @@
 [![Codecov test coverage](https://codecov.io/gh/jdreyf/DirectionalMaxPTest/branch/main/graph/badge.svg)](https://app.codecov.io/gh/jdreyf/DirectionalMaxPTest?branch=main)
 <!-- badges: end -->
 
-# DirectionalMaxPTest
+# DirectionalMaxPTest
+
+Directional MaxP test for replication, mediation, & qualitative interactions.
+
+## Install
+Install `DirectionalMaxPTest` from GitHub using the `remotes` (or `devtools`) package within R.
+
+```
+# install.packages("remotes") # You must install `remotes` if you haven't before
+library(remotes)
+remotes::install_github(repo="jdreyf/DirectionalMaxPTest")
+```
+
+To see examples of its use, see [analyze_screendmt_dihome_replication.Rmd](https://github.com/jdreyf/screendmt-dihome-replication/blob/main/analyze_screendmt_dihome_replication.Rmd), where we apply it to lipidomics analysis.