VEuPathDB / web-monorepo

A monorepo that contains all frontend code for VEuPathDB websites
Apache License 2.0
2 stars 0 forks source link

Mbio: add expandable info section to apps #771

Open asizemore opened 8 months ago

asizemore commented 8 months ago

Our apps run some serious computations that are worth explaining a bit to the user. Also we've had user feedback asking for more details on the functions we use for the computations, etc. So, we'd like to add an expandable section, just like with the mosaic plots, that offer more description about the computation.

Each app would use a specific text that describes the computation, and i think the expandable section could go right below th ecomputation inputs. So for example in the next line below Data and Method, but before step 2 in the screenshot. Totally happy to make mockups if that would help!

Screen Shot 2024-01-16 at 11 52 24 AM

This ticket will require work from a few folks. To start:

d-callan commented 8 months ago

adding comments from the other ticket here, to consolidate the two

There are a lot of places wed like to do some explaining for the computes. some things that come to mind immediately:

Tell people were using pcoa in beta div, and why and what it might be good or bad at Tell people what parameters were using w maaslin2 in diff abund, and why and what it might be good or bad at Tell people about correlation methods used in the correlation apps, particularly once we introduce compositional methods for taxa-taxa Tell people what prefilters were using for features in correlation apps Tell people where they can find the R if theyd like Other things i havent thought of yet

asizemore commented 7 months ago

Not totally done, #860 only completed this for the correlation app. We'll revisit the rest for b68