argonDash/index.Rmd at master · RinteRface/argonDash · GitHub

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
---
output: github_document
always_allow_html: true
---

```{r setup, include=FALSE}
library(bslib)
knitr::opts_chunk$set(echo = TRUE)
```

# argonDash <img src="http://www.rinterface.com/inst/images/argonDash.svg" width=200 align="right" alt="argon hex sticker"/>

[![R build status](https://github.com/RinteRface/argonDash/workflows/R-CMD-check/badge.svg)](https://github.com/RinteRface/argonDash/actions)
[![CRAN status](https://www.r-pkg.org/badges/version/argonDash)](https://cran.r-project.org/package=argonDash)
[![lifecycle](https://img.shields.io/badge/lifecycle-maturing-ff69b4.svg)](https://lifecycle.r-lib.org/articles/stages.html#maturing)
[![cranlogs](https://cranlogs.r-pkg.org/badges/argonDash)](https://cran.r-project.org/package=argonDash)

> argon Bootstrap4 dashboard template for Shiny

## Installation

`{argonDash}` requires to install `{argonR}`.

```r
install.packages("argonR")
# devel version
devtools::install_github("RinteRface/argonDash")
# from CRAN
install.packages("argonDash")
```

## Demo

You can play with the demo app below and modify the code.

```{r basic-code, eval=TRUE, echo=FALSE}
card(
  argonDash:::create_app_link(
    argonDash:::shinylive_links["inst/examples/shinylive/gallery"],
    mode = "editor"
  ),
  full_screen = TRUE,
  style = "margin: 0 auto; float: none;"
)
```

<br/>

```r
library(argonDash)
argonDashGallery()
```

We provide some placeholder images served in the `images` folder, so you just have to do this to access them:

```r
argonAvatar(
  size = "sm",
  src = "images/undraw_profile-pic_fatv.svg"
)
```

### Vertical layout
<br>
<img src="man/figures/argonDashDemo.png" alt="argon dashboard demo with vertical layout">

### Horizontal layout

This layout is experimental.

<br>
<img src="man/figures/argonDashDemo_horizontal.png" alt="argon dashboard demo with horizontal layout">

## Aknowledgement

* [Creative Tim](https://www.creative-tim.com/) for designing the original argon dashboard HTML template.

## Code of Conduct

  Please note that the argonDash 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.