-
Notifications
You must be signed in to change notification settings - Fork 276
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Galaxy/Bioconductor shiny hackathon blog post #2742
Merged
Merged
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
16638e3
WIP: Galaxy/Bioconductor shiny hackathon blog post
hrhotz 186fbe1
Add files via upload
hrhotz 3003f0d
Update content/news/2024-08-21-hosting-shiny-apps-on-EU/index.md
hrhotz b2a98de
Update content/news/2024-08-21-hosting-shiny-apps-on-EU/index.md
hrhotz f8616b5
Update content/news/2024-08-21-hosting-shiny-apps-on-EU/index.md
hrhotz 22b5db3
Update content/news/2024-08-21-hosting-shiny-apps-on-EU/index.md
hrhotz 4a90e5f
Update content/news/2024-08-21-hosting-shiny-apps-on-EU/index.md
hrhotz 2a943a1
Update index.md
hrhotz bc03158
adding a dot - Update index.md
hrhotz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
title: 'Hosting R/Shiny applications on Galaxy (and other frameworks)' | ||
date: '2024-08-21' | ||
tease: "Thanks to the outcome of a small Galaxy/Bioconductor hackathon earlier this year, it has become much easier to deploy a Shiny phyloseq App as an interactive tool (IT) on usegalaxy.eu" | ||
hrhotz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
hide_tease: false | ||
authors: Charlotte Soneson, Federico Marini, Björn Grüning, Hans-Rudolf Hotz | ||
subsites: [all-eu, global] | ||
--- | ||
|
||
During the EuroBioC2022 conference in Heidelberg, Germany, a group of participants gathered to discuss [R/Shiny applications](https://shiny.posit.co/), with particular focus on those included in Bioconductor packages. During the discussion, it was suggested that Galaxy may be a good venue for hosting such apps, as a complement to, e.g., shinyapps.io, where the free tier may not provide enough computational and storage capacity for practical usage of all apps. Although, some R/Shiny apps already existed as Galaxy interactive tools, e.g. [iSEE](https://usegalaxy.eu/root?tool_id=interactive_tool_isee), it became evident during a later discussion between Galaxy and Bioconductor representatives, that more work towards setting up (generally usable) templates would be necessary to simplify the inclusion of more apps. These templates should make it easy to make any Shiny app (not only coming from the Bioconductor environment) available in Galaxy and other frameworks. | ||
|
||
On February 29th/March 1st 2024, representatives from the Bioconductor and the Galaxy communities (Charlotte Soneson, Federico Marini, Björn Grüning, and Hans-Rudolf Hotz) met in Freiburg for a short hackathon to learn from the 'other side', to brainstorm (see picture), to start working on the templates and to implement the first tool. | ||
|
||
<img src="./brainstorm.png" style="max-width: 400px" alt="brainstorming" /> | ||
|
||
Initial work concentrated around the [ideal package](https://bioconductor.org/packages/release/bioc/html/ideal.html). The corresponding Shiny app already offered the stopApp functionality (see: [close-window](https://deanattali.com/blog/advanced-shiny-tips/#close-window)) which deemed to be very useful to cleanly close the app and eventually stop the container. A [proof of concept](https://github.com/federicomarini/docker-ideal) was generated and the dockerized shiny application was made available at the European Galaxy server as an [interactive tool](https://usegalaxy.eu/?tool_id=interactive_tool_ideal&version=latest). | ||
hrhotz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
In order to provide a general usable recipe, two repositories were set up with easy-to-expand (i.e. exchange with your favorite Shiny application) templates: | ||
|
||
[templateDockerShinyPkg](https://github.com/csoneson/templateDockerShinyPkg) | ||
As a prerequisite, the shiny application needs to be available as a package. This repository contains a small package providing a template for a shiny application, suitable for running in a container environment. | ||
|
||
[templateDockerShiny](https://github.com/hrhotz/templateDockerShiny) | ||
Using this Dockerfile, the template shiny application can be dockerized | ||
|
||
|
||
Once the Shiny-App Docker container is created and publicly available to everyone, it can be integrated into Galaxy. The process is very similar to the integration of a normal Galaxy tool and [described in the GTN](https://training.galaxyproject.org/training-material/topics/dev/tutorials/interactive-tools/tutorial.html). Alternatively you can drop us a message in our [Galaxy Tool Chat](https://matrix.to/#/#galaxy-iuc_iuc:gitter.im) or create a [new issue](https://github.com/galaxyproject/tools-iuc/issues/new) to inform us about your new App. We will try to integrate it for you and deploy if on the European Galaxy server. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "...and deploy if..." -> "...and deploy it..." There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. fixed |
||
|
||
Ultimately, the goal will be to add such interactive tools to (existing) Galaxy workflows. More work for another Hackathon in the future. | ||
hrhotz marked this conversation as resolved.
Show resolved
Hide resolved
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be more general (i.e. not specifically for phyloseq)? E.g.
"Thanks to the outcome of a small Galaxy/Bioconductor hackathon earlier this year, it has become much easier to deploy Shiny applications as interactive tools (ITs) on usegalaxy.eu"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks like this is a typo from my side....I will fix it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ah, the github wizard has already done it - Thanks