From 0be27d01feb3da2a6ad6f73bf0d4dbe33f2c0c4e Mon Sep 17 00:00:00 2001 From: Jakub Nowicki Date: Mon, 9 Jan 2023 13:49:15 +0100 Subject: [PATCH 1/3] docs: Update readme. --- README.md | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 9a85724..c976450 100644 --- a/README.md +++ b/README.md @@ -3,23 +3,21 @@ > _Tools to measure performance improvements in Shiny apps._ +[![CRAN status](https://www.r-pkg.org/badges/version/shiny.benchmark)](https://cran.r-project.org/package=shiny.benchmark) [![R-CMD-check](https://github.com/Appsilon/shiny.benchmark/workflows/R-CMD-check/badge.svg)](https://github.com/Appsilon/shiny.benchmark/actions?workflow=R-CMD-check) -[![codecov](https://codecov.io/github/Appsilon/shiny.benchmark/branch/develop/graph/badge.svg?token=JBEL2P5GIO)](https://codecov.io/github/Appsilon/shiny.benchmark) `shiny.benchmark` is a tool aimed to measure and compare the performance of different versions of a `shiny` application. Based on a list of different application versions, accessible by a git repo by its refs (commit hash or branch name), the user can write instructions to be executed using Cypress or `shinytest2`. These instructions are then evaluated by the different versions of your `shiny` application and therefore the performance's improvement/deterioration (time elapsed) are be recorded. The package is flexible enough to allow different sets of tests for the different refs as well as different package versions (via `renv`). Also, the user can replicate the tests to have more accurate measures of performance. -How to install? ---------------- +## How to install? ```r remotes::install_github("Appsilon/shiny.benchmark") ``` -Dependencies ------------- +## Dependencies `shiny.benchmark` can use two different engines to test the change in the performance of your application: [shinytest2](https://rstudio.github.io/shinytest2/) and [Cypress](https://www.cypress.io/). The latter requires `Node` (version 12 or higher) and `yarn` (version 1.22.17 or higher) to be available. @@ -31,8 +29,7 @@ To install them on your computer, follow the guidelines on the documentation pag Besides that, on Linux, it might be required to install other `Cypress` dependencies. Check the [documentation](https://docs.cypress.io/guides/getting-started/installing-cypress#Linux-Prerequisites) to find out more. -How to use it? --------------- +## How to use it? The best way to start using `shiny.benchmark` is through an example. If you want a start point, you can use the `load_example` function. In order to use this, create a new folder in your computer and use the following code to generate an application to serve us as example for our performance checks: @@ -160,21 +157,19 @@ summary(out) plot(out) ``` -How to contribute? ------------------- +## How to contribute? If you want to contribute to this project please submit a regular PR, once you're done with new feature or bug fix. Reporting a bug is also helpful - please use [GitHub issues](https://github.com/Appsilon/shiny.benchmark/issues) and describe your problem as detailed as possible. -Appsilon -======== +## Appsilon -Appsilon is the **Full Service Certified Posit Partner**. Learn more +Appsilon is a **Posit (formerly RStudio) Full Service Certified Partner**. Learn more at [appsilon.com](https://appsilon.com). -Get in touch [opensource@appsilon.com](opensource@appsilon.com) +Get in touch [opensource@appsilon.com](mailto:opensource@appsilon.com) We are hiring! From 4f5e5193dca84becf3187664eaeab3207ef5e7a2 Mon Sep 17 00:00:00 2001 From: Jakub Nowicki Date: Mon, 9 Jan 2023 13:49:32 +0100 Subject: [PATCH 2/3] chore: Update documentation website. --- pkgdown/_pkgdown.yml | 20 ++++++++++++++++++++ pkgdown/extra.css | 11 +++++++++++ 2 files changed, 31 insertions(+) diff --git a/pkgdown/_pkgdown.yml b/pkgdown/_pkgdown.yml index d01650d..a7b789c 100644 --- a/pkgdown/_pkgdown.yml +++ b/pkgdown/_pkgdown.yml @@ -14,6 +14,9 @@ template: gtag('js', new Date()); gtag('config', 'G-RS06EY8KNQ'); + + before_navbar: | + url: https://github.com/Appsilon/shiny.benchmark/ @@ -34,6 +37,17 @@ navbar: href: https://github.com/Appsilon/shiny.benchmark - icon: fa-twitter fa-lg href: https://twitter.com/Appsilon + - icon: fab fa-mastodon fa-lg + href: https://fosstodon.org/@appsilon + +home: + sidebar: + structure: [star, links, license, community, citation, authors, dev] + components: + star: + title: GitHub + text: | + Star reference: - title: Performance tests @@ -52,3 +66,9 @@ reference: - title: Other contents: - '`load_example`' + +footer: + structure: + left: developed + components: + developed: "Developed with :heart: by [Appsilon](https://appsilon.com)." diff --git a/pkgdown/extra.css b/pkgdown/extra.css index 7f9c6f3..482904a 100644 --- a/pkgdown/extra.css +++ b/pkgdown/extra.css @@ -33,6 +33,17 @@ button.btn.btn-primary.btn-copy-ex { border-color: rgb(178, 9, 41); } +.home { + left: 0px; + position: absolute; + padding: 8px 30px; + color: rgba(255,255,255,0.55); +} + +.home:hover { + color: rgba(255,255,255,0.9); +} + .app-preview { margin: 1.5em 0.75em; padding: 0.25em; From e26a22e4b892f42cf84cb9116468c78f010ac6d0 Mon Sep 17 00:00:00 2001 From: Jakub Nowicki Date: Mon, 9 Jan 2023 13:50:08 +0100 Subject: [PATCH 3/3] chore: Build documentation page on push to main. --- .github/workflows/pkgdown.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pkgdown.yml b/.github/workflows/pkgdown.yml index 352ce54..a8edc0a 100644 --- a/.github/workflows/pkgdown.yml +++ b/.github/workflows/pkgdown.yml @@ -3,7 +3,7 @@ on: push: branches: - - develop + - main workflow_dispatch: name: pkgdown