From 5ca5f4abf5f1798261c9ce5e565961ef51101054 Mon Sep 17 00:00:00 2001 From: jonathan dreyfuss Date: Mon, 31 Jul 2023 17:22:15 -0400 Subject: [PATCH] update readme --- DESCRIPTION | 4 ++-- README.md | 15 ++++++++++++++- 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 3594e8e..3a63e74 100644 --- 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 index 201dc61..7c92bb1 100644 --- 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) -# DirectionalMaxPTest \ No newline at end of file +# 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. \ No newline at end of file