waldronlab / BugSigDB

A microbial signatures database
https://bugsigdb.org
7 stars 6 forks source link

Variable region showing only under first experiment for papers with multiple experiments #173

Closed ftzohra22 closed 1 year ago

ftzohra22 commented 1 year ago

https://bugsigdb.org/Study_750 has more than one experiment and the variable region is not showing under Experiment 1. The information is entered but does not appear to be saving and showing on the saved pages for the subsequent experiments.

ftzohra22 commented 1 year ago

@tosfos just noticed this is an issue for all the studies with multiple experiments

tosfos commented 1 year ago

It looks like this field is actually working fine. It's some of the other ones that are problematic. We did implement difference checking for the Experiments that works as follows:

If a certain field in Experiment 2 has the same value as in Experiment 1, it should not be displayed. We will always set the semantic property, so that it can be queried and show up in the CSV exports.

The exception is for all fields in the Alpha Diversity section, which should always be displayed on all Experiments, as requested in #120.

We'll work on fixing this. Please let me know if any of the above is incorrect, @lwaldron @lgeistlinger .

tosfos commented 1 year ago

Please review:

bugsigdb wikiteq com_Study_696-original

All unchanged values in Experiment 2 are being hidden. We are showing all changes in Alpha Diversity no matter what, but in this Study's Experiment 2, only Chao1 is filled in.

If this looks OK, we'll apply it to production.

tosfos commented 1 year ago

For comparison, here is the same page in production: https://bugsigdb.org/Study_696

lwaldron commented 1 year ago

Sorry I missed this earlier. Your proposal looks good @tosfos , showing only the differences (except for alpha diversity) for subsequent experiments makes it much easier to see how each experiment differs.

tosfos commented 1 year ago

This has been fixed. You will see decreased site performance for a bit.

We did notice one issue that should be discussed. Sometimes certain Experiments have fields with no value, and this results in an output that might not be expected.

Please check Study 750, MHT correction. In this Experiment, we get an interesting output because Experiment 3 does not have this field set.

  1. Experiment 1, value Yes (shown, correct)
  2. Experiment 2, value Yes (omitted, correct)
  3. Experiment 3, value not set (shown parameter with no value, correct)
  4. Experiment 4, value Yes (shown, correct)

Although the Experiment 3 MHT correction printout follows the logic (it is shown because by being blank it is not equal to the preceding value), the printout without any value looks confusing. Would it be helpful to output Not specified or something similar? Removal of empty parameters looks worse as it can be interpreted as "unchanged". Or are unset values an error of omission that should default to a certain value?

lwaldron commented 1 year ago

We could:

  1. add "not specified" as an option then not allow this field to be unfilled.
  2. possibly require it to be either "yes" or "no", since even when it's unspecified you should be able to infer it, but that's probably too much to ask of all curators.
  3. as-is with displaying "not specified" when it's unfilled.

Option 3 seems the easiest and just fine, not requiring replacing currently blank values with "not specified". Even the status quo doesn't seem bad if there's much work involved, since this should be a relatively rare curation error. That particular example in Study 750 it is a curation error, and I doubt a study would ever specify that they used MHT for the first two experiments, then changed strategy and didn't specify for the third (and it would also be odd to change from yes to no between experiments in the same paper).

tosfos commented 1 year ago

We implemented option 3.

tosfos commented 1 year ago

Can this be closed?

lwaldron commented 1 year ago

Yes, looks good.