From c74a600082aedcadf37a58bddae4d7651e339205 Mon Sep 17 00:00:00 2001 From: donyunardi Date: Fri, 15 Sep 2023 17:58:09 +0000 Subject: [PATCH] deploy: 7d27aa0107178fa6f28adf1697ce912edd19e689 --- demo.html | 37 ++++++++++++++++++----------------- index.html | 56 ++++++++++++++++++++++++++++++++--------------------- sitemap.xml | 4 ++-- 3 files changed, 55 insertions(+), 42 deletions(-) diff --git a/demo.html b/demo.html index b6346770..197f4813 100644 --- a/demo.html +++ b/demo.html @@ -183,6 +183,7 @@
+ Click on the card to open it. Click on the icon to see further instructions. Click on the icon to see the source code.

Teal Gallery Demo

@@ -190,7 +191,7 @@

Teal Gallery Demo

- basic-teal + basic-teal @@ -198,14 +199,14 @@

Teal Gallery Demo

- + Animation of the basic-teal app Animation of the basic-teal app
- exploratory + exploratory @@ -213,14 +214,14 @@

Teal Gallery Demo

- + Animation of the exploratory app Animation of the exploratory app
- safety + safety @@ -228,14 +229,14 @@

Teal Gallery Demo

- + Animation of the safety app Animation of the safety app
- efficacy + efficacy @@ -243,14 +244,14 @@

Teal Gallery Demo

- + Animation of the efficacy app Animation of the efficacy app
- patient-profile + patient-profile @@ -258,14 +259,14 @@

Teal Gallery Demo

- + Animation of the patient-profile app Animation of the patient-profile app
- early-dev + early-dev @@ -273,14 +274,14 @@

Teal Gallery Demo

- + Animation of the early-dev app Animation of the early-dev app
- longitudinal + longitudinal @@ -288,14 +289,14 @@

Teal Gallery Demo

- + Animation of the longitudinal app Animation of the longitudinal app
- RNA-seq + RNA-seq @@ -303,14 +304,14 @@

Teal Gallery Demo

- + Animation of the RNA-seq app Animation of the RNA-seq app
- python + python @@ -318,7 +319,7 @@

Teal Gallery Demo

- + Animation of the python app Animation of the python app diff --git a/index.html b/index.html index c8dd2533..8fc26baf 100644 --- a/index.html +++ b/index.html @@ -157,15 +157,15 @@

Links to app

Development version

@@ -173,10 +173,13 @@

Development versionRunning the apps

You can run any of these apps by just executing these two lines of code in your R console.

By sourcing the sourceme.R file you make sure that you have access to the restore_and_run()

+

Note: Make sure to install renv before you do this. Also, it is recommended that you create and use a Github PAT. Once you have the PAT, run the following:

+
Sys.setenv(GITHUB_PAT = "your_access_token_here")

Running the restore_and_run("APP_NAME") will run the APP_NAME by restoring the packages using renv

-
source("https://raw.github.com/insightsengineering/teal.gallery/main/_internal/utils/sourceme.R")
-# Assuming you want to run the "basic-teal" app. Refer to the list above to know which apps are possible
-restore_and_run("basic-teal")
+
source("https://raw.github.com/insightsengineering/teal.gallery/main/_internal/utils/sourceme.R")
+
+# Run the basic-teal app
+restore_and_run("basic-teal")

Development

@@ -184,13 +187,21 @@

Development

Adding a sample app to teal.gallery

Adding a sample app involves the following steps:

+
+

Hard requirements

    -
  1. Copy each sample app into a file named app.R into a sensible folder name inside it’s own directory. The directory is also the APP_NAME.
    2. -
  2. Make sure that {renv} is used for the teal app.
    3. -
  3. Create a GIF recording (KAP is a good tool for this). Make sure that the dimensions of the GIF is 970x555 px and the size is about 1 MB. (It can be done by recording using KAP in 1470x840 px and rendering 5fps and downsizing 33%). Place the GIF inside the _internal/quarto/assets/img directory. Also, make sure that the name of the GIF is APP_NAME.gif. Also, make sure to place a static image with the name dimention called APP_NAME.png that will be displayed in the demo page when the card is not hovered.
    4. +
  4. Copy each sample app into a file named app.R into a sensible folder name inside it’s own directory. The directory has to be named with the APP_NAME.
  5. Update the _internal/quarto/demo-apps.yml with a new app/title. This should be the APP_NAME.
  6. Run the _internal/utils/generate_app_readme.R to generate the readme for the app inside it’s own directory.
+
+
+

Optional/Soft requirements

+
    +
  1. You can snapshot the teal app dependencies using {renv} but make sure to snapshot using GitHub references to the teal packages.
    2. +
  2. Create a GIF recording (KAP is a good tool for this). Make sure that the dimensions of the GIF is 970x555 px and the size is about 1 MB. (It can be done by recording using KAP in 1470x840 px and rendering 5fps and downsizing 33%). Place the GIF inside the _internal/quarto/assets/img directory. Also, make sure that the name of the GIF is APP_NAME.gif. Also, make sure to place a static image with the name dimention called APP_NAME.png that will be displayed in the demo page when the card is not hovered.
    3. +
  3. Add front-end tests with the help of cypress. Copy the contents of the js directory within some other app’s directory inside your app directory to get the node dependencies. Place the cypress tests inside the tests/cypress inside your app’s directory. Please refer to an existing app’s tests so that the .github/deploy.yaml will automaticall run the cypress tests.
    4. +
@@ -198,6 +209,7 @@

Adding

+