insightsengineering / teal.gallery

A Gallery of Exploratory Web Apps used for Analyzing Clinical Trial Data
https://insightsengineering.github.io/teal.gallery/
Other
29 stars 7 forks source link

_dev or _stable? #91

Closed donyunardi closed 8 months ago

donyunardi commented 1 year ago

https://github.com/insightsengineering/teal.gallery/blob/6cbee27c2e9c63e4b549a36170c109ad604bfc47/README.md?plain=1#L16-L26

Shouldn't the Development version points to _dev URL instead of _stable?

hzhang2-cims commented 11 months ago

Dear developers, I wanted to make sure that all these apps are currently dependent on development version right(as of 11/16/2023)? As I currently cannot load them following the readme instructions. (although I can open them online by clicking the link.)

Sys.setenv(GITHUB_PAT = "I put my github token here")

source("https://raw.github.com/insightsengineering/teal.gallery/main/_internal/utils/sourceme.R")

# Run the basic-teal app
restore_and_run("basic-teal")

It keeps failing at the stage of setting up project libraries using renv. My local package version:

> packageVersion(pkg = "renv")
[1] ‘1.0.3’
> packageVersion(pkg = "teal")
[1] ‘0.14.0’

My R version: 4.3.1


One more question: I found these modules that I can put together in general analysis modules, which is an awesome point to begin exploring. But when I tried looking for the independent modules in teal.modules.clinical. I found that there are no available code of already built modules there that I can try playing with, only the following two articles. Could you kindly guide me to the document(if there is one) where there are some example code of well-built modules using teal.modules.clinical(stable version) that I can try out? image

Thanks in advance for reviewing my questions.

m7pr commented 8 months ago

@donyunardi

Shouldn't the Development version points to _dev URL instead of _stable?

If we want to have different URLs in the README for different branches then this is doable - each branch has a different content of this file. However if we ever plan to merge one to another then the file would get overwritten.

So we either

What do you think @vedhav ?

vedhav commented 8 months ago

Yeah, Development version should be renamed as Stable version. I think it's worth displaying both stable and dev versions of the app in a table like this instead, created a PR for the same:

Stable version Dev version
basic-teal basic-teal
exploratory exploratory
safety safety
efficacy efficacy
patient-profile patient-profile
early-dev early-dev
longitudinal longitudinal
RNA-seq RNA-seq
python python
vedhav commented 8 months ago

@hzhang2-cims Can you try the local app run steps once again? All the modules present in teal.modules.general and teal.modules.clinical have a working example in their function documentation. So, I would recommend having a look at them from the reference page. Additionally, you can also have a look at the TLG-Catalog which explains more about the data processing steps followed by the teal app creation.