{"id":14066323,"url":"https://github.com/insightsengineering/teal.gallery","last_synced_at":"2025-04-12T18:31:46.188Z","repository":{"id":78057369,"uuid":"561597397","full_name":"insightsengineering/teal.gallery","owner":"insightsengineering","description":"A Gallery of Exploratory Web Apps used for Analyzing Clinical Trial Data","archived":false,"fork":false,"pushed_at":"2025-04-09T17:23:48.000Z","size":61551,"stargazers_count":33,"open_issues_count":20,"forks_count":9,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-04-09T18:37:23.815Z","etag":null,"topics":["clinical-trials","nest","r","shiny","webapp"],"latest_commit_sha":null,"homepage":"https://insightsengineering.github.io/teal.gallery/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/insightsengineering.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":["https://pharmaverse.org"]}},"created_at":"2022-11-04T03:17:31.000Z","updated_at":"2025-04-09T03:50:56.000Z","dependencies_parsed_at":"2023-03-01T10:00:16.873Z","dependency_job_id":"3bb92d42-6b01-44e6-9e45-f7f3b7ec57e1","html_url":"https://github.com/insightsengineering/teal.gallery","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insightsengineering%2Fteal.gallery","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insightsengineering%2Fteal.gallery/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insightsengineering%2Fteal.gallery/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insightsengineering%2Fteal.gallery/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/insightsengineering","download_url":"https://codeload.github.com/insightsengineering/teal.gallery/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248613512,"owners_count":21133525,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clinical-trials","nest","r","shiny","webapp"],"created_at":"2024-08-13T07:05:02.578Z","updated_at":"2025-04-12T18:31:41.174Z","avatar_url":"https://github.com/insightsengineering.png","language":"R","funding_links":["https://pharmaverse.org"],"categories":["R","Ranked by starred repositories"],"sub_categories":[],"readme":"# teal.gallery\n\n\u003ca href=\"https://github.com/insightsengineering/teal\" target=\"_blank\"\u003e\n  \u003cimg align=\"right\" width=auto height=\"100\" src=\"https://raw.githubusercontent.com/insightsengineering/hex-stickers/main/PNG/teal.png\" style=\"margin-left:10px;\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://github.com/insightsengineering/teal.gallery\" target=\"_blank\"\u003e\n  \u003cimg align=\"right\" width=auto height=\"100\" src=\"https://raw.githubusercontent.com/insightsengineering/hex-stickers/main/PNG/teal.gallery.png\"\u003e\n\u003c/a\u003e\n\nA gallery of sample apps based on the [`teal`](https://github.com/insightsengineering/teal) framework.\n\n## Links to apps on `shinyapps.io`\n\nThe Stable version of the apps use the latest released packages while the dev version of the apps use the development packages which are installed from the `main` branch of the respective package repository. The specific versions used can be seen in the `Session Info` of the deployed app.\n\n\n| Stable version                                    | Dev version                                     |\n|---------------------------------------------------|-------------------------------------------------|\n| [basic-teal](https://genentech.shinyapps.io/NEST_basic-teal_stable/)          | [basic-teal](https://genentech.shinyapps.io/NEST_basic-teal_dev/)         |\n| [exploratory](https://genentech.shinyapps.io/NEST_exploratory_stable/)        | [exploratory](https://genentech.shinyapps.io/NEST_exploratory_dev/)       |\n| [safety](https://genentech.shinyapps.io/NEST_safety_stable/)                  | [safety](https://genentech.shinyapps.io/NEST_safety_dev/)                 |\n| [efficacy](https://genentech.shinyapps.io/NEST_efficacy_stable/)              | [efficacy](https://genentech.shinyapps.io/NEST_efficacy_dev/)             |\n| [patient-profile](https://genentech.shinyapps.io/NEST_patient-profile_stable/) | [patient-profile](https://genentech.shinyapps.io/NEST_patient-profile_dev/)|\n| [early-dev](https://genentech.shinyapps.io/NEST_early-dev_stable/)             | [early-dev](https://genentech.shinyapps.io/NEST_early-dev_dev/)           |\n| [longitudinal](https://genentech.shinyapps.io/NEST_longitudinal_stable/)       | [longitudinal](https://genentech.shinyapps.io/NEST_longitudinal_dev/)     |\n| [RNA-seq](https://genentech.shinyapps.io/NEST_RNA-seq_stable/)                 | [RNA-seq](https://genentech.shinyapps.io/NEST_RNA-seq_dev/)               |\n| [python](https://genentech.shinyapps.io/NEST_python_stable/)                   | [python](https://genentech.shinyapps.io/NEST_python_dev/)                 |\n\n\n## Running the apps\n\nYou can run any of these apps by just executing these two lines of code in your R console.\n\nBy sourcing the [sourceme.R](https://github.com/insightsengineering/teal.gallery/blob/main/utils/sourceme.R) file you make sure that you have access to the `restore_and_run()`\n\nNote: Make sure to install [renv](https://rstudio.github.io/renv/index.html) before you do this. Also, it is recommended that you create and use a Github PAT. Once you have the PAT, run the following:\n\n```R\nSys.setenv(GITHUB_PAT = \"your_access_token_here\")\n```\n\nRunning the `restore_and_run(\"APP_NAME\")` will run the `APP_NAME` by restoring the packages using [renv](https://rstudio.github.io/renv/)\n\n```R\nsource(\"https://raw.github.com/insightsengineering/teal.gallery/main/_internal/utils/sourceme.R\")\n\n# Run the basic-teal app\nrestore_and_run(\"basic-teal\")\n```\n\n## Development\n\nAll `teal` sample apps are wrapped into this repository into it's own sub-directory. All development standards and practices that we currently use for teal app development also apply to this repository.\n\n### Auto-deployment\n\nAll the sample apps are automatically deployed every day using the CI in two channels:\n\n- `stable` channel: The code for the Teal apps is taken from the `main` branch of `teal.gallery`, and the NEST packages are installed from the `main` branch of GitHub. This is done using the `deploy_stable.yaml`.\n- `dev` channel: The code for the Teal apps is taken from the `dev` branch of `teal.gallery` and the NEST packages are installed from the last `release tag` of GitHub. This is done using the `deploy_dev.yaml`.\n\n_IMPORTANT_: Although we can now test the unreleased features of the NEST packages in deployments, currently, the divergent `dev` and `main` branches must be managed and merged manually as needed to ensure that the apps work fine in both deployment channels, i.e., making sure to merge the app changes from `dev` to `main` by creating a PR.\n\n### Adding a sample app to `teal.gallery`\n\nAdding a sample app involves the following steps:\n\n#### Hard requirements\n\n1. 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`.\n2. Update the `_internal/quarto/demo-apps.yml` with a new `app/title`. This should be the `APP_NAME`.\n3. Run the `_internal/utils/generate_app_readme.R` to generate the readme for the app inside it's own directory.\n\n#### Optional/Soft requirements\n\n1. You can snapshot the teal app dependencies using `{renv}` but make sure to snapshot using GitHub references to the teal packages.\n2. Create a GIF recording ([KAP](https://getkap.co/) 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.\n3. 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finsightsengineering%2Fteal.gallery","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finsightsengineering%2Fteal.gallery","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finsightsengineering%2Fteal.gallery/lists"}