Home

Awesome

<!-- README.md is generated from README.Rmd. Please edit that file -->

easyalluvial <a href='https://erblast.github.io/easyalluvial'><img src='man/figures/logo.png' align="right" height="139" /></a>

R build
status Coverage
Status CRAN last
release CRAN total
downloads CRAN monthly
downloads

Alluvial plots are similar to sankey diagrams and visualise categorical data over multiple dimensions as flows. Rosval et. al. 2010 Their graphical grammar however is a bit more complex then that of a regular x/y plots. The ggalluvial package made a great job of translating that grammar into ggplot2 syntax and gives you many option to tweak the appearance of an alluvial plot, however there still remains a multi-layered complexity that makes it difficult to use ‘ggalluvial’ for explorative data analysis. ‘easyalluvial’ provides a simple interface to this package that allows you to produce a decent alluvial plot from any dataframe in either long or wide format from a single line of code while also handling continuous data. It is meant to allow a quick visualisation of entire dataframes with a focus on different colouring options that can make alluvial plots a great tool for data exploration.

Features

Installation

CRAN

install.packages('easyalluvial')

Development Version


# install.packages("devtools")
devtools::install_github("erblast/easyalluvial")

Documentation

Examples

suppressPackageStartupMessages( require(tidyverse) )
suppressPackageStartupMessages( require(easyalluvial) )

Alluvial from data in wide format

Sample Data


knitr::kable( head(mtcars2) )
mpgcyldisphpdratwtqsecvsamgearcarbids
21.061601103.902.62016.46Vmanual44Mazda RX4
21.061601103.902.87517.02Vmanual44Mazda RX4 Wag
22.84108933.852.32018.61Smanual41Datsun 710
21.462581103.083.21519.44Sautomatic31Hornet 4 Drive
18.783601753.153.44017.02Vautomatic32Hornet Sportabout
18.162251052.763.46020.22Sautomatic31Valiant

Plot

Continuous Variables will be automatically binned as follows.


alluvial_wide( data = mtcars2
                , max_variables = 5
                , fill_by = 'first_variable' )

<!-- -->

Alluvial from data in long format

Sample Data

knitr::kable( head(quarterly_flights) )
tailnumcarrierorigindestqumean_arr_delay
N0EGMQ LGA BNA MQMQLGABNAQ1on_time
N0EGMQ LGA BNA MQMQLGABNAQ2on_time
N0EGMQ LGA BNA MQMQLGABNAQ3on_time
N0EGMQ LGA BNA MQMQLGABNAQ4on_time
N11150 EWR MCI EVEVEWRMCIQ1late
N11150 EWR MCI EVEVEWRMCIQ2late

Plot


alluvial_long( quarterly_flights
               , key = qu
               , value = mean_arr_delay
               , id = tailnum
               , fill = carrier )

<!-- -->

Marginal Histograms

alluvial_wide( data = mtcars2
                , max_variables = 5
                , fill_by = 'first_variable' ) %>%
  add_marginal_histograms(mtcars2)

<!-- -->

Interactive Graphs


suppressPackageStartupMessages( require(parcats) )

p = alluvial_wide(mtcars2, max_variables = 5)

parcats(p, marginal_histograms = TRUE, data_input = mtcars2)
<figure> <img src="https://raw.githubusercontent.com/erblast/parcats/master/man/figures/demo1.gif" alt="demo" /> <figcaption aria-hidden="true">demo</figcaption> </figure>

Partial Dependence Alluvial Plots

Alluvial plots are capable of displaying higher dimensional data on a plane, thus lend themselves to plot the response of a statistical model to changes in the input data across multiple dimensions. The practical limit here is 4 dimensions while conventional partial dependence plots are limited to 2 dimensions.

Briefly the 4 variables with the highest feature importance for a given model are selected and 5 values spread over the variable range are selected for each. Then a grid of all possible combinations is created. All none-plotted variables are set to the values found in the first row of the training data set. Using this artificial data space model predictions are being generated. This process is then repeated for each row in the training data set and the overall model response is averaged in the end. Each of the possible combinations is plotted as a flow which is coloured by the bin corresponding to the average model response generated by that particular combination.

easyalluvial contains wrappers for parsnip and caret models. Custom Wrappers for other models can easily be created.


df = select(mtcars2, -ids)

m = parsnip::rand_forest(mode = "regression") %>%
  parsnip::set_engine("randomForest") %>%
  parsnip::fit(disp ~ ., df)

p = alluvial_model_response_parsnip(m, df, degree = 4, method = "pdp")
#> Getting partial dependence plot preditions. This can take a while. See easyalluvial::get_pdp_predictions() `Details` on how to use multiprocessing

p_grid = add_marginal_histograms(p, df, plot = F) %>%
  add_imp_plot(p, df)

<!-- -->

Interactive Partial Dependence Plot


parcats(p, marginal_histograms = TRUE, imp = TRUE, data_input = df)

demo - Live Widget

ClinicoPath {jamovi} Module

ClinicoPath jamovi Module (thanks to Serdar Balci) adds easyalluvial plots to jamovia spreadsheet interface for doing statistics with R.

Similar Packages