https://github.com/feddelegrand7/flipdownr
📆📆📆 Implement a Countdown in RMarkdown Documents and Shiny Applications
https://github.com/feddelegrand7/flipdownr
javascript rmarkdown rstats shiny
Last synced: 4 months ago
JSON representation
📆📆📆 Implement a Countdown in RMarkdown Documents and Shiny Applications
- Host: GitHub
- URL: https://github.com/feddelegrand7/flipdownr
- Owner: feddelegrand7
- License: other
- Created: 2020-10-16T13:11:05.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-01-23T11:25:37.000Z (about 4 years ago)
- Last Synced: 2024-10-04T21:37:07.364Z (5 months ago)
- Topics: javascript, rmarkdown, rstats, shiny
- Language: R
- Homepage: https://ihaddadenfodil.com/post/introducing-the-flipdownr-package-create-a-countdown-in-rmarkdown-documents-and-shiny-apps/
- Size: 1.72 MB
- Stars: 30
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - feddelegrand7/flipdownr - 📆📆📆 Implement a Countdown in RMarkdown Documents and Shiny Applications (R)
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# flipdownr 
[](https://cran.r-project.org/package=flipdownr)
[](https://cran.r-project.org/package=flipdownr)
[](https://cran.r-project.org/package=flipdownr)
[](https://cran.r-project.org/package=flipdownr)
[](https://choosealicense.com/licenses/mit/)
[](https://github.com/feddelegrand7/flipdownr)
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](https://pbutcher.uk/flipdown/)
## Installation
You can install `flipdownr` from CRAN with:
```{r, eval=FALSE}
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](https://ihaddadenfodil.com/post/introducing-the-flipdownr-package-create-a-countdown-in-rmarkdown-documents-and-shiny-apps/)
## 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](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.