Skip to content

Commit

Permalink
update index, readme
Browse files Browse the repository at this point in the history
  • Loading branch information
DivadNojnarg committed Aug 20, 2024
1 parent b004868 commit c27f73e
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 67 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@ inst/examples/**/rsconnect
.vscode
*.icloud
docs

/.quarto/
Binary file modified R/sysdata.rda
Binary file not shown.
14 changes: 2 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<br>

<div class="card">
<a href="https://dgranjon.shinyapps.io/virtual_patient_v2/" target="_blank"><img src="https://community.rstudio.com/uploads/default/original/2X/e/eb1013fd09ccf10cbe13da3f0168eebfcb0eba75.gif"></a>
<img src="https://community.rstudio.com/uploads/default/original/2X/e/eb1013fd09ccf10cbe13da3f0168eebfcb0eba75.gif">
</div>

<br>
Expand Down Expand Up @@ -59,7 +59,7 @@ server <- function(input, output) {
shinyApp(ui, server)
```

Starting from v2.0.0, moving to `{bs4Dash}` is rather simple:
Moving to `{bs4Dash}` is rather simple, as we just replace `library(shinydashboard)`:

```r
library(bs4Dash)
Expand Down Expand Up @@ -92,14 +92,6 @@ server <- function(input, output) {
shinyApp(ui, server)
```


## Upgrading bs4Dash to 2.0.0
- `{bs4Dash}` is undergoing major rework to make it easier to come from `{shinydashboard}`. The current development version 2.0.0 provides a 1:1 supports, in other word moving from `{shinydashboard}` to `{bs4Dash}` is accomplished by changing `library(shinydashboard)` to `library(bs4Dash)`.

- `{bs4Dash}` v2.0.0 also provides 1:1 with `{shinydashboardPlus}` to ease compatibility.

- Apps built with `{bs4Dash}` version <= 0.5.0 are definitely not compatible with v2.0.0 due to substantial breaking changes in the API. We advise users to keep the old version for old apps and move to to the new version for newer apps.

## Installation

```r
Expand All @@ -110,8 +102,6 @@ install.packages("bs4Dash")
```

## Demo

See a working example on shinyapps.io [here](https://dgranjon.shinyapps.io/bs4DashDemo/).
You may also run:

```r
Expand Down
31 changes: 12 additions & 19 deletions index.Rmd
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
output: github_document
always_allow_html: true
---

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

Expand All @@ -20,23 +23,22 @@ knitr::opts_chunk$set(echo = TRUE)
<br>

<div class="card">
<a href="https://dgranjon.shinyapps.io/virtual_patient_v2/" target="_blank"><img src="https://community.rstudio.com/uploads/default/original/2X/e/eb1013fd09ccf10cbe13da3f0168eebfcb0eba75.gif"></a>
</div>
```{r socialBox-code, eval=TRUE, echo=FALSE}
card(
bs4Dash:::create_link_iframe(bs4Dash:::shinylive_links["inst/examples/showcase"]),
full_screen = TRUE,
style = "margin: 0 auto; float: none;"
)
```

<br>

<div class="card">
<a href="https://analytichealth.co.uk/pharmly-portal/" target="_blank"><img src="https://analytichealth.co.uk/wp-content/uploads/2021/10/PA-bs4Dash.gif"></a>
</div>

<br>

```{r, echo=FALSE}
bs4Dash:::app_container("https://dgranjon.shinyapps.io/virtual_patient_v2/", deps = TRUE)
```

## New users moving to bs4Dash v2.0.0
## From shinydashboard to bs4Dash

Taking the simple `{shinydashboard}` example:

Expand Down Expand Up @@ -73,7 +75,7 @@ server <- function(input, output) {
shinyApp(ui, server)
```

Starting from v2.0.0, moving to `{bs4Dash}` is rather simple:
Moving to `{bs4Dash}` is rather simple, as we just replace `library(shinydashboard)`:

```r
library(bs4Dash)
Expand Down Expand Up @@ -106,14 +108,6 @@ server <- function(input, output) {
shinyApp(ui, server)
```


## Upgrading bs4Dash to 2.0.0
- `{bs4Dash}` is undergoing major rework to make it easier to come from `{shinydashboard}`. The current development version 2.0.0 provides a 1:1 supports, in other word moving from `{shinydashboard}` to `{bs4Dash}` is accomplished by changing `library(shinydashboard)` to `library(bs4Dash)`.

- `{bs4Dash}` v2.0.0 also provides 1:1 with `{shinydashboardPlus}` to ease compatibility.

- Apps built with `{bs4Dash}` version <= 0.5.0 are definitely not compatible with v2.0.0 due to substantial breaking changes in the API. We advise users to keep the old version for old apps and move to to the new version for newer apps.

## Installation

```r
Expand All @@ -124,7 +118,6 @@ install.packages("bs4Dash")
```

## Demo
See a working example on shinyapps.io [here](https://dgranjon.shinyapps.io/bs4DashDemo/).
You may also run:

```r
Expand Down
Loading

0 comments on commit c27f73e

Please sign in to comment.