gravitytrope / exploremodelmatrix

Explore design matrices interactively with R/Shiny

ExploreModelMatrix

ExploreModelMatrix is a small R package that lets the user interactively explore a design matrix. In particular, given a table with sample information and a design formula, ExploreModelMatrix will illustrate the fitted values (or, more generally, the value of the linear predictor) for each combination of input variables, simplifying understanding and generation of contrasts.

ExploreModelMatrix is still under development and we welcome feedback. Please open an issue if you encounter unexpected behaviour.

Installation

You can install ExploreModelMatrix with the remotes (or devtools) package, like so:

remotes::install_github("csoneson/ExploreModelMatrix", build_vignettes = TRUE, dependencies = TRUE)

For this to work, you need to have the remotes R package installed. If you don't already have it, you can install it like this:

install.packages("remotes")

Usage

The main function in the ExploreModelMatrix package is called ExploreModelMatrix. When calling ExploreModelMatrix, simply provide a data.frame with sample information and a design formula:

sampleData <- data.frame(genotype = rep(c("A", "B"), each = 4),
                         treatment = rep(c("ctrl", "trt"), 4))
ExploreModelMatrix(sampleData = sampleData,
                   designFormula = ~ genotype + treatment)

This will open up an R/Shiny application where you can explore the specified design matrix and the fitted values for each combination of predictor values.

For more examples of designs, please see the vignette.