- Notifications
You must be signed in to change notification settings - Fork4
🌱 🌱 🌱 Create an HTML Vertical Timeline Widget in RMarkdown and Shiny
License
feddelegrand7/cronologia
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
The goal ofcronologia is to create an interactive timeline widget inRMarkdown documents and Shiny applications.
You can install the stable version from CRAN with
install.packages("cronologia")Thecronologia 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 ascreate_tml()except thatit adds and additional description component.
In order to showcase the package’s features, let’s create a simple dataframe:
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#> date_release title#> 1 May 31, 2005 Batman Begins#> 2 July 14, 2008 The Dark Knight#> 3 July 16, 2012 The Dark Knight Rises
Now, usingcreate_tml(), we can create easily a timeline as follows:
library(cronologia)create_tml(df=batman_data,# the data framesmr="title",# the column that will be used in the summarydsc="date_release"# the column that will be used in the description )
You can easily customize the appearance of the time line using theparameters provided:
create_tml(df=batman_data,smr="title",# summarydsc="date_release",# descriptionsmr_col="blue",# summary text colorsmr_bgcol="orange",# summary background colordsc_col="white",# description text colordsc_bgcol="black",# description background colordsc_size="30px"# description size )
If you want to make all the summary components open by default, you canset theopen parameter toTRUE. The parameter is available in allthe functions.
If you want to include images within your timeline, you can use thecreate_tml_img() function. To illustrate this function, we’ll use theradous package that fetch therandomuser.me API and returns a data framethat contains many information (including images’ URLs).
Disclaimer: All the generated images are extracted from the authorizedsection of UI Faces.
library(radous)df<- get_data(n=4,seed="123")df[c('name_last','location_street_name','picture_large','name_last')]#> # A tibble: 4 x 4#> name_last location_street_na~ picture_large name_last#> <chr> <chr> <chr> <chr>#> 1 Campos Rua Três https://randomuser.me/api/portraits/m~ Campos#> 2 Jackson Armagh Street https://randomuser.me/api/portraits/w~ Jackson#> 3 Ruona Hämeentie https://randomuser.me/api/portraits/w~ Ruona#> 4 Steward Henry Street https://randomuser.me/api/portraits/w~ Steward
Now we will proceed as previously except that we need to provide twoadditional arguments:
imgsrc: the column that indicates the source of the images.imgalt: the column indicating thealtattribute of the images.For accessibility reasons I decided to make this argument mandatory.Use a column that contains""if the images do not need thealtattribute.
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")
Following the idea ofTobias forcreating an interactive CV I thought that two (2) description componentswould be more appropriate. The function is similar tocreate_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#> jobs period todos#> 1 Game tester at Nintendo 2020-2022 Playing Zelda all day#> 2 Food tester at Ferrero 2022-2024 Eating Bueno all day#> 3 Movies tester at Netflix 2026-2030 Watching the Office all day
create_tml_2(cv,smr="jobs",dsc="period",dsc2="todos",dsc2_col="white",dsc2_bgcol="peru")# yes, peru is also a color
- Writing unit tests
- Creating a hex sticker
- Sharing with RWeekly
- Talk about it at a virtual event
Please note that thecronologia project is released with aContributor Code ofConduct.By contributing to this project, you agree to abide by its terms.
About
🌱 🌱 🌱 Create an HTML Vertical Timeline Widget in RMarkdown and Shiny
Topics
Resources
License
Code of conduct
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.