flipdownr <a><img src='man/figures/hex.png' align="right" height="200" /></a>

The goal of flipdownr is to create a Countdown object within your RMarkdown documents and Shiny application. flipdownr is an R wrapper of the JavaScript library flipdown

<br>

Installation

You can install flipdownr from CRAN with:

install.packages("flipdownr")

Functions and Arguments

flipdownr has one function: flipdown which contains the following arguments:

downto: the targeted date for the countdown. It must have the form of ‘yyyy-mm-dd’ or ‘yyyy-mm-dd hh:mm:ss`. Note that you can include the time zone (example UTC): ’yyyy-mm-dd hh:mm:ss UTC’;

id: the id of the countdown. Useful when you need to include many countdown objects in one document;

theme: The theme of the flipdown object. For now you can choose from the following themes (if you have a preference don’t hesitate to modify the flipdown.min.css file and send a PR): ‘dark’, ‘light’, ‘gdila’, ‘youkous’, ‘ifri’, ‘saida’;

headings: A character vector specifying the heading related to each time part. Defaults to English headings: c(“Days”, “Hours”, “Minutes”, “Seconds”).

Examples

A demo is available here

Themes

The dark and light themes are exhibited within the demo above. Below you can check out the other themes:

gdila

saida

youkous

ifri

Code of Conduct

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

Flipdownr

Install / Use

README