timeline_rd3: Interactive time-bar plot.

View source: R/timeline.R

timeline_rd3R Documentation

Interactive time-bar plot.

Description

timeline_rd3 produces a timeline_rd3 object ready for its representation as an interactive time line in a web browser.

Usage

timeline_rd3(periods, name = "name", start = "start", end = "end", group = NULL,
             text = NULL, main = NULL, note = NULL, info = NULL,
             events = NULL, eventNames = "name", eventPeriod = "period",
             eventTime = "date", eventColor = NULL, eventShape = NULL,
             cex = 1, language = c("en","es","ca"), dir = NULL)

Arguments

periods

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

name

name of the column with names in the periods data frame.

start

name of the column with starts in the periods data frame.

end

name of the column with ends in the periods data frame.

group

name of the column with a grouping criteria in the periods data frame.

text

name of the column with a descriptive text of periods (html format) in the periods data frame.

main

upper title of the graph.

note

lower title of the graph.

info

name of the column in the periods data frame with information to display on the information panel.

events

a data frame of events related to periods (shown as dots) with three columns: interval name, event name and event date

eventNames

name of the column with event identifiers in the events data frame.

eventPeriod

name of the column with interval identifiers in the events data frame.

eventTime

name of the column with time points in the events data frame.

eventColor

name of the column with the color criteria in the events data frame.

eventShape

name of the column with the shape criteria in the events data frame.

cex

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

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 timeline_rd3.

Author(s)

Modesto Escobar, Department of Sociology and Communication, University of Salamanca.

Examples

# Database of 19th century sociologists
data(sociologists)
timeline <- timeline_rd3(sociologists,"name","birth","death","birthcountry")
## Not run: 
plot(timeline)

## End(Not run)

rD3plot documentation built on March 31, 2023, 7:15 p.m.