Learn R Programming

⚠️There's a newer version (2.1.0) of this package.Take me there.

neatmaps

Overview

The goal of the neatmaps package is to simplify the exploratory data analysis process for multiple network data sets with the help of hierarchical clustering and heatmaps. Multiple network data consists of multiple disjoint networks that share common graph, node and edge variables. This package contains the necessary tools to convert this raw data into a dynamic report, summarizing the relationships between the graph, node and structural characteristics of the networks.

Installation

# To install neatmaps, simply run the following code:
install.packages('neatmaps')

Code Example

library(neatmaps)

# Create a "cleaned" dataframe using the netsDataFrame function
df <- netsDataFrame(net.attr.df = networkAttrDF,
                    node.attr.df = nodeAttrDF,
                    edge.df = edgeDF)

# Run the neatmap function on the dataframe. This will produce a list
# consisting of the dendrogram of the networks' variables, the significant
# clusters of the bootstrap analysis, the results of the statistical analysis
# and the heatmap.
resultsList <- neatmap(df, scale.df = "basic", mainTitle = "Heatmap", 
                   xlabel = "Chararacteritics", ylabel = "Networks",
                   link.method = "single", dist.method = "euclidean",
                   nBootRep = 100)

To display the heatmap:

resultsList[[4]]

To display the dendrogram:

plotDendrogram(dend = resultsList[[1]],
               results = resultsList[[3]],
               labelsCex = 1,
               pCex = 1)

To list the significant clusters:

formatCluster(resultsList[[2]])

Dynamic Report

A dynamic report template has been included in the inst/rmd directory. Follow the instruction at the top of template.Rmd to create a dynamic report using your own data.

Documentation

Available on CRAN.

Copy Link

Version

Install

install.packages('neatmaps')

Monthly Downloads

244

Version

1.0.6

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Phil Boileau

Last Published

October 16th, 2017

Functions in neatmaps (1.0.6)

getStructureAttr

Structural Attributes of Networks Data Frame
hierarchy

Hierarchy
compactNodeAttr

Node Attribute Compactor
createNetworks

Create Networks Using Edge Data Frame
networkAttrDF

Network Attributes Data
nodeAttrDF

Node Attribute Data
neatmap

Heatmap of Networks
netsDataFrame

Networks Data Frame
scaleColumns

Scale Between 0 and 1
plotDendrogram

Plot Dendrogram
edgeDF

Edge List Data
formatCluster

Format Cluster Output