timeLineGraphics {timeLineGraphics}R Documentation

timeLineGraphics

Description

This function is the driver that organizes the production of an html page containing horizontal strips that symbolize events in a person's life.

Usage

timeLineGraphics(
  l,
  vfactor = 3,
  abline = TRUE,
  bkgRBG = c(13, 65, 130),
  ablineRBG = c(26, 85, 145),
  pdfWidth = 20,
  pdfHeight = 20,
  extendRight = 50,
  yearsTicks = 10,
  ymargin = 0.05,
  nameCEX = 4,
  main = "Timelines",
  WidthHTML = 850,
  imageDir = tempdir(),
  leftOver = TRUE
)

Arguments

l

is a list

  • character string $name the person's name

  • integer $start starting year

  • integer $end ending year

  • character string $color background color for the horizontal line

  • list of overlay pictures $pics, each entry contains

    • character string path name for a picture

    • integer year for placement of left edge of picture

vfactor

is height of a horizontal strip

abline

is Boolean if TRUE add dates and corresponding vertical ablines

bkgRBG

is ie c(13,65,130) specifying background color

ablineRBG

specifying abline color

pdfWidth

the width parameter to pdf()

pdfHeight

the height parameter to pdf()

extendRight

extends plot to the right to provide room to fit in names

yearsTicks

number of years interval between x axis ticks

ymargin

is fraction of maxy to leave as top and bottom margin

nameCEX

control size of font in text() to display names associated with each horizontal strip

main

main title for the graph

WidthHTML

the width of the figure when imported into html page

imageDir

where to save the image output files

leftOver

if TRUE then pictures that do not fit in horizontal strip are placed to left of strip rather than omitted

Details

the parameters here work fine in general but they were tuned to match the chart in https://mathigon.org/timeline since my intention is to generate a consistent display of that chart and my chart above one another a consideration is to have the horizontal strips sufficiently tall so that the images of the in-laid paintings can be seen clearly the default RBG values match the design in https://mathigon.org/timeline construct graph whose x axis is years y axis is items to be plotted such as a person's years of birth and death within a broad colored horizontal line overlain with pictures related to that person

Value

No return value, called for side effects


[Package timeLineGraphics version 1.0 Index]