Skip to content

Commit 35f8eac

Browse files
committed
notes again ...
1 parent feb97b5 commit 35f8eac

File tree

4 files changed

+88
-692
lines changed

4 files changed

+88
-692
lines changed

.Rbuildignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,4 @@
1515
^CRAN-SUBMISSION$
1616
^_pkgdown\.yml$
1717
^index\.Rmd$
18+
^README\.Rmd$

README.Rmd

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
output: github_document
3+
---
4+
5+
<!-- README.md is generated from README.Rmd. Please edit that file -->
6+
7+
```{r, include = FALSE}
8+
knitr::opts_chunk$set(
9+
collapse = TRUE,
10+
comment = "#>",
11+
fig.path = "man/figures/README-",
12+
out.width = "100%"
13+
)
14+
```
15+
16+
# shinydashboardPlus <img src="https://rinterface.com/inst/images/shinydashboardPlus.svg" width="200px" align="right"/>
17+
18+
[![R build status](https://github.com/RinteRface/shinydashboardPlus/workflows/R-CMD-check/badge.svg)](https://github.com/RinteRface/shinydashboardPlus/actions)
19+
[![version](https://www.r-pkg.org/badges/version/shinydashboardPlus)](https://CRAN.R-project.org/package=shinydashboardPlus)
20+
[![cranlogs](https://cranlogs.r-pkg.org/badges/shinydashboardPlus)](https://CRAN.R-project.org/package=shinydashboardPlus)
21+
[![total](https://cranlogs.r-pkg.org/badges/grand-total/shinydashboardPlus)](https://CRAN.R-project.org/package=shinydashboardPlus)
22+
23+
> extensions for shinydashboard
24+
25+
## Installation
26+
27+
```r
28+
# for the CRAN version
29+
install.packages("shinydashboardPlus")
30+
# for the latest version
31+
devtools::install_github("RinteRface/shinydashboardPlus")
32+
```
33+
34+
## Motivations
35+
36+
shinydashboardPlus is based on the idea of [ygdashboard](https://github.com/gyang274/ygdashboard/tree/master/R),
37+
the latter not compatible with shinydashboard (you cannot use shinydashboard and ygdashboard at the same time). With shinydashboardPlus you can still work with the shinydashboard classic functions and enrich
38+
your dashboard with all additional functions of shinydashboardPlus!
39+
40+
## Demo
41+
42+
See a demonstration [here](https://shinylive.io/r/editor/#h=0&code=NobwRAdghgtgpmAXGKAHVA6ASmANGAYwHsIAXOMpMAGwEsAjAJykYE8AKAZwAtaJWAlAB0IdJiw48+rACZQe9IixnDRDZmy69+chUsYyACtQCunVSKn8AgugAitRl1adyMDADNa1OOyFg4AA9YVB9Of1wAAlQoAgBrKABzOEiAXkj-K1l5bkVlYzN-AQEwAF8AXSA)
43+
or run:
44+
45+
```r
46+
library(shinydashboardPlus)
47+
shinydashboardPlusGallery()
48+
```
49+
50+
Below an example of application in medicine:
51+
52+
<img src="man/figures/shinydashPlus_demo.png" width="848" height="530">
53+
<br>
54+
55+
## Acknowledgements
56+
57+
- The [adminLTE team](https://adminlte.io)
58+
- [Victor Perrier](https://github.com/pvictor) from [Dream'R](https://www.dreamrs.fr)
59+
60+
## Code of Conduct
61+
62+
Please note that the shinydashboardPlus 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.

README.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
1+
2+
<!-- README.md is generated from README.Rmd. Please edit that file -->
3+
14
# shinydashboardPlus <img src="https://rinterface.com/inst/images/shinydashboardPlus.svg" width="200px" align="right"/>
25

3-
[![R build status](https://github.com/RinteRface/shinydashboardPlus/workflows/R-CMD-check/badge.svg)](https://github.com/RinteRface/shinydashboardPlus/actions)
6+
[![R build
7+
status](https://github.com/RinteRface/shinydashboardPlus/workflows/R-CMD-check/badge.svg)](https://github.com/RinteRface/shinydashboardPlus/actions)
48
[![version](https://www.r-pkg.org/badges/version/shinydashboardPlus)](https://CRAN.R-project.org/package=shinydashboardPlus)
59
[![cranlogs](https://cranlogs.r-pkg.org/badges/shinydashboardPlus)](https://CRAN.R-project.org/package=shinydashboardPlus)
6-
[![total](https://cranlogs.r-pkg.org/badges/grand-total/shinydashboardPlus)](https://www.rpackages.io/package/shinydashboardPlus)
10+
[![total](https://cranlogs.r-pkg.org/badges/grand-total/shinydashboardPlus)](https://CRAN.R-project.org/package=shinydashboardPlus)
711

812
> extensions for shinydashboard
913
1014
## Installation
1115

12-
```r
16+
``` r
1317
# for the CRAN version
1418
install.packages("shinydashboardPlus")
1519
# for the latest version
@@ -18,15 +22,21 @@ devtools::install_github("RinteRface/shinydashboardPlus")
1822

1923
## Motivations
2024

21-
shinydashboardPlus is based on the idea of [ygdashboard](https://github.com/gyang274/ygdashboard/tree/master/R),
22-
the latter not compatible with shinydashboard (you cannot use shinydashboard and ygdashboard at the same time). With shinydashboardPlus you can still work with the shinydashboard classic functions and enrich
23-
your dashboard with all additional functions of shinydashboardPlus!
25+
shinydashboardPlus is based on the idea of
26+
[ygdashboard](https://github.com/gyang274/ygdashboard/tree/master/R),
27+
the latter not compatible with shinydashboard (you cannot use
28+
shinydashboard and ygdashboard at the same time). With
29+
shinydashboardPlus you can still work with the shinydashboard classic
30+
functions and enrich your dashboard with all additional functions of
31+
shinydashboardPlus!
2432

2533
## Demo
2634

27-
See a demonstration [here](https://shinylive.io/r/editor/#h=0&code=NobwRAdghgtgpmAXGKAHVA6ASmANGAYwHsIAXOMpMAGwEsAjAJykYE8AKAZwAtaJWAlAB0IdJiw48+rACZQe9IixnDRDZmy69+chUsYyACtQCunVSKn8AgugAitRl1adyMDADNa1OOyFg4AA9YVB9Of1wAAlQoAgBrKABzOEiAXkj-K1l5bkVlYzN-AQEwAF8AXSA)
35+
See a demonstration
36+
[here](https://shinylive.io/r/editor/#h=0&code=NobwRAdghgtgpmAXGKAHVA6ASmANGAYwHsIAXOMpMAGwEsAjAJykYE8AKAZwAtaJWAlAB0IdJiw48+rACZQe9IixnDRDZmy69+chUsYyACtQCunVSKn8AgugAitRl1adyMDADNa1OOyFg4AA9YVB9Of1wAAlQoAgBrKABzOEiAXkj-K1l5bkVlYzN-AQEwAF8AXSA)
2837
or run:
29-
```r
38+
39+
``` r
3040
library(shinydashboardPlus)
3141
shinydashboardPlusGallery()
3242
```
@@ -39,9 +49,12 @@ Below an example of application in medicine:
3949
## Acknowledgements
4050

4151
- The [adminLTE team](https://adminlte.io)
42-
- [Victor Perrier](https://github.com/pvictor) from [Dream'R](https://www.dreamrs.fr)
43-
52+
- [Victor Perrier](https://github.com/pvictor) from
53+
[Dream’R](https://www.dreamrs.fr)
4454

4555
## Code of Conduct
46-
47-
Please note that the shinydashboardPlus 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.
56+
57+
Please note that the shinydashboardPlus project is released with a
58+
[Contributor Code of
59+
Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html).
60+
By contributing to this project, you agree to abide by its terms.

0 commit comments

Comments
 (0)