gallery {netCoin}R Documentation

Images in a grid gallery.

Description

gallery produces a gallery_rd3 object.

Usage

gallery(nodes, tree = NULL, name = NULL, label = NULL, color = NULL,
    border = NULL, ntext = NULL, info = NULL, infoFrame = c("right","left"),
    image = NULL, zoom = 1, itemsPerRow = NULL, main = NULL, note = NULL,
    showLegend = TRUE, frequencies = FALSE,
    help = NULL, helpOn = FALSE, tutorial = FALSE, description = NULL,
    descriptionWidth = NULL, roundedItems = FALSE, controls = 1:5, cex = 1,
    defaultColor = "#1f77b4", language = c("en", "es", "ca"), dir = NULL)

Arguments

nodes

a data frame with at least three columns of names, start and end.

tree

a data frame with two columns: source and target, describing relationships between nodes. It indicates a hierarchy between nodes which can be dynamically explored.

name

column name with image names in the nodes data frame.

label

column name with image labels in the nodes data frame.

color

column name with image background color variable in the nodes data frame.

border

column name with image border width variable in the nodes data frame or a numeric vector.

ntext

column name with html text in the nodes data frame.

info

column name with information to display in a panel in the nodes data frame.

infoFrame

In which panel should the information be displayed? The left panel is only available if the description argument is provided and frequencies are not showing.

image

column name which indicates the image paths in the nodes data frame.

zoom

a number between 0.1 and 10 as initial displaying zoom.

itemsPerRow

number of items in each row.

main

upper title of the graph.

note

lower title of the graph.

frequencies

a logical value true if barplots representing node attributes frequencies will be added to the final graph.

showLegend

a logical value true if the legend is to be shown.

help

a character string indicating a help text of the graph.

helpOn

Should the help be shown at the beginning?

tutorial

Should tutorial be displayed?

description

a character string indicating a desription text for the graph.

descriptionWidth

a percentage indicating a width for the description panel (25 by default).

roundedItems

Display items with rounded borders.

controls

a numeric vector indicating which controls will be shown. 1 = topbar, 2 = pdf exportation, 3 = xlsx exportation, 4 = table, 5 = netCoin logo. NULL hide all controls, negative values deny each control and 0 deny all.

cex

number indicating the amount by which plotting text should be scaled relative to the default.

defaultColor

a character vector giving a valid html color for node representation.

language

a character string indicating the language of the graph (en=english (default); es=spanish; ca=catalan).

dir

a character string representing the directory where the web files will be saved.

Value

Object of class gallery_rd3.

Author(s)

Modesto Escobar, Department of Sociology and Communication, University of Salamanca. See https://sociocav.usal.es/blog/modesto-escobar/

Examples

data("finches")
finches$species <- system.file("extdata", finches$species,
        package="netCoin") # copy path to the species field
gallery(finches, image="species", main="Species in Galapagos Islands",
        note="Data source: Sanderson (2000)")

[Package netCoin version 2.0.48 Index]