In feddelegrand7/cronologia: Create an HTML Vertical Timeline from a Data Frame in 'rmarkdown' and 'shiny'

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

cronologia

The goal of cronologia is to create an interactive timeline widget in RMarkdown documents and Shiny applications.

Installation

You can install the stable version from CRAN with

install.packages("cronologia")

Introduction

The cronologia package has three functions:

• create_tml() : used to create simple text-based timelines.
• create_tml_img(): used to create timelines that include images.
• create_tml_2(): works the same way as create_tml() except that it adds and additional description component.

Examples

create_tml()

In order to showcase the package's features, let's create a simple data frame:

batman_data <- data.frame(


  date_release = c("May 31, 2005",
                   "July 14, 2008",
                   "July 16, 2012 "),

  title = c("Batman Begins",
                  "The Dark Knight",
                  "The Dark Knight Rises")
)

batman_data

Now, using create_tml(), we can create easily a timeline as follows:

library(cronologia)


create_tml(df = batman_data, # the data frame
           smr = "title", # the column that will be used in the summary 
           dsc = "date_release" # the column that will be used in the description
           )

You can easily customize the appearance of the time line using the parameters provided:

create_tml(df = batman_data,
           smr = "title", # summary
           dsc = "date_release", # description
           smr_col = "blue", # summary text color
           smr_bgcol = "orange", # summary background color
           dsc_col = "white", # description text color
           dsc_bgcol = "black", # description background color
           dsc_size = "30px" # description size
           )

r paste0(emo::ji("exclamation"), emo::ji("exclamation"), emo::ji("exclamation"))

If you want to make all the summary components open by default, you can set the open parameter to TRUE. The parameter is available in all the functions.

create_tml_img()

If you want to include images within your timeline, you can use the create_tml_img() function. To illustrate this function, we'll use the radous package that fetch the randomuser.me API and returns a data frame that contains many information (including images' URLs).

Disclaimer: All the generated images are extracted from the authorized section of UI Faces.

library(radous)

df <- get_data(n = 4, seed = "123")

df[c('name_last', 
     'location_street_name',
     'picture_large',
     'name_last')]

Now we will proceed as previously except that we need to provide two additional arguments:

• imgsrc: the column that indicates the source of the images.
• imgalt: the column indicating the alt attribute of the images. For accessibility reasons I decided to make this argument mandatory. Use a column that contains "" if the images do not need the alt attribute.

df <- radous::get_data(4, seed = "123")

create_tml_img(df, 
               smr = "name_last", 
               dsc = "location_street_name", 
               imgsrc = "picture_large", 
               imgalt = "name_last", 
               imgwidth = "150px", 
               imgheight = "150px", 
               dsc_size = "20px")

create_tml_2()

Following the idea of Tobias for creating an interactive CV I thought that two (2) description components would be more appropriate. The function is similar to create_tml() except that it adds another description paragraph to the Timeline.

Let's go through an example:

cv <- data.frame(


  jobs = c("Game tester at Nintendo", "Food tester at Ferrero", "Movies tester at Netflix"), 

  period = c("2020-2022", "2022-2024", "2026-2030"),

  todos = c("Playing Zelda all day", "Eating Bueno all day", "Watching the Office all day")

)


cv

create_tml_2(cv, 
             smr = "jobs", 
             dsc = "period", 
             dsc2 = "todos", 
             dsc2_col = "white",
             dsc2_bgcol = "peru") # yes, peru is also a color

TODOS

• [x] Writing unit tests
• [ ] Creating a hex sticker
• [x] Sharing with RWeekly
• [ ] Talk about it at a virtual event

Code of Conduct

Please note that the cronologia project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

feddelegrand7/cronologia documentation built on April 25, 2021, 4:42 a.m.