-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
170 lines (99 loc) · 3.34 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# bubblyr <a><img src='man/figures/hex.png' align="right" height="200" /></a>
<!-- badges: start -->
[](https://cran.r-project.org/package=bubblyr)
[](https://cran.r-project.org/package=bubblyr)
[](https://cran.r-project.org/package=bubblyr)
[](https://choosealicense.com/licenses/mit/)
[](https://github.com/feddelegrand7/bubblyr/actions)
<!-- badges: end -->
`bubblyr` is an R wrapper of the JavaScript library [bubbly-bg](https://github.com/tipsy/bubbly-bg). It allows you to add beautiful animated bubbles within Shiny and RMarkdown backgrounds. You can choose from several themes and apply the animation with one line of code.
<center>
## Installation
You can install the `bubblyr` package from CRAN with:
```{r, eval=FALSE}
install.packages("bubblyr")
```
You can install the development version of `bubblyr` from Github with:
```{r, eval=FALSE}
install.packages("remotes") #if not installed
remotes::install_github("feddelegrand7/bubblyr")
```
# Themes
Here a list of all the available themes. Note that The ocean, cherry, hippie, bigmom and deepsea themes are provided by the author of the bubbly-bg JavaScript library, I just gave them some fancy names:
```{r, echo=FALSE}
list <- c(
"ocean",
"cherry",
"hippie",
"bigmom",
"deepsea",
"illusion",
"rstudio",
"ash",
"classy",
"volcano",
"lacoste",
"warmup",
"fire",
"traffic",
"life",
"darksky",
"orangina",
"meteor",
"gravitas",
"rladies",
"sunshine",
"sweet",
"lalaland"
)
knitr::kable(list, col.names = "Themes")
```
Below you can find some examples, feel free to experiment the remaining themes:
#### Important: You may experiment some lags when viewing your Shiny/Rmd Document in the RStudio pane, instead use the browser.
```{r, eval=FALSE}
library(shiny)
library(bubblyr)
ui <- fluidPage(
bubbly(theme = "bigmom")
)
server <- function(input, output) {}
shinyApp(ui = ui, server = server)
```
```{r, eval=FALSE}
library(shiny)
library(bubblyr)
ui <- fluidPage(
bubbly(theme = "rstudio")
)
server <- function(input, output) {}
shinyApp(ui = ui, server = server)
```
```{r, eval=FALSE}
library(shiny)
library(bubblyr)
ui <- fluidPage(
bubbly(theme = "classy")
)
server <- function(input, output) {}
shinyApp(ui = ui, server = server)
```
## Code of Conduct
Please note that the bubblyr 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.