Learn R Programming

GSNA (version 0.1.4.2)

gsnDistanceHistogram: gsnDistanceHistogram

Description

Generate a Histogram of Distances

Usage

gsnDistanceHistogram(
  object,
  distance = NULL,
  dist.matrix = c("raw", "pared", "edges"),
  stat = "percent",
  colors = NULL,
  bins = 100
)

Value

A ggplot2 graphical object.

Arguments

object

A GSNData object

distance

A distance, or even a character vector of distances, e.g. c("lf", "jaccard", "stlf").

dist.matrix

The names of distance matrices, which can be "raw" for the distance stored in "matrix", "pared" for the distances stored in "pared", and "edges" for the distances stored in "edges". In general, the distances in "edges" will be the same as those in "pared", but this may not always be true.

stat

Can be "percent", "count", "density", or "cumulative". This determines how the data are visualized.

colors

Currently, this does nothing, but will eventually allow the user to specify custom colors. Stay tuned.

bins

The number of bins, for histograms ("percent" or "count").

Details

This function is useful for such purposes as assessing the effects of paring on the distribution of distances.

See Also

plot.GSNData gsnPlotNetwork gsnHierarchicalDendrogram