From 2db0b7034a4f24f90356eaaf3c912f644573770d Mon Sep 17 00:00:00 2001 From: Danielle Callan Date: Fri, 24 Nov 2023 22:47:35 -0500 Subject: [PATCH] update readme --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0f40e38..3edf51c 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,15 @@ A practical example, from the microbiome space, might be the correlations betwee and separate column of nodes. Links between these two columns of nodes are weighted by the absolute value of the correlation coefficient and colored by the direction of the correlation. ## Currently, this is: -An R Shiny app that uploads a file and attempts to validate it. It will produce a histogram of correlation coefficients, and a histogram of (for now, dummy) p-values. There are inputs to filter the edges of the network by correlation coefficient and p-value. Currently, the edges are only visible in a table. -Run what I currently have, from R, like this: `shiny::runApp(launch.browser=T)` +An R Shiny app that uploads a file and attempts to validate it. It will produce a histogram of correlation coefficients, and a histogram of (for now, dummy) p-values. There are inputs to filter the edges of the network by correlation coefficient and p-value. Currently, the edges are visible in a network and a table. +Run what I currently have, after installing the package in R, like this: `corGraph::corGraph()` +Once the app has started, use the provided test file `inst/extdata/test_cor_matrix.tsv`. ## Some things I really need to do Outside of playing w gpt-pilot, I think this is a cool app and want to do some housekeeping so that it can actually be destributed as a package. So I need to: -* document inline w roxygen yet -* update Imports in the DESC file * clean up the test data/ * write some tests -* add a helper fxn to launch the app +* add a second file input +* run the correlation myself and produce real p-values +* add labels to the nodes in the network diagram +* make the network interactive so you get a scatter plot when you click an edge