Add a simple "notes for data users" field for a given study

[fedarko]

As brought up in a meeting this morning. This could include information relevant to users interested in using data from that study, preferably in a brief couple of sentences/bullet points.

I know there's the "Abstract" field, but in my experience that is usually just the straight-up abstract from a writeup, and I've literally never seen it used in this way. The proposed field could just be a simple string that'd be shown towards the top of the Study Information (and maybe Sample Information?) pages.

Some immediately obvious example things that a "Notes for data users" field could be used for:

• For the AGP (study ID 10317), mention the bloom filter (maybe even link to the paper on correcting for fecal blooms) and explain that we strongly recommend applying this to the data due to the vast majority of the samples being shipped at room-temperature

• For a study where some samples were incorrectly collected or processed somehow (as was brought up as an example problematic scenario in this morning's meeting), mention which samples are bad (or refer to the sample mapping/metadata info, e.g. "the samples where is_sample_terrible is YEAH should be filtered out of downstream analyses")

• For a study with metadata column names that are hard to interpret in isolation, give explanations for what these columns mean (e.g. "the is_a_cool_dude metadata column is YES for samples where the host's name is Antonio, and PROBABLY NOT for all other examples")

I think esp. the bloom filter example would make this sort of feature valuable.

[ackermag]

This could also be used for additional studies where the data was used. i.e. where data from a previous study was used for a meta-analysis and then published.

…

On Fri, Oct 11, 2019 at 11:24 AM Marcus Fedarko ***@***.***> wrote: As brought up in a meeting this morning. This could include information relevant to users interested in using data from that study, preferably in a brief couple of sentences/bullet points. I know there's the "Abstract" field, but in my experience that is usually just the straight-up abstract from a writeup, and I've literally never seen it used in this way. The proposed field could just be a simple string that'd be shown towards the top of the Study Information (and maybe Sample Information?) pages. Some immediately obvious example things that a "Notes for data users" field could be used for: - For the AGP (study ID 10317), mention the bloom filter (maybe even link to the paper on correcting for fecal blooms) and explain that we strongly recommend applying this to the data due to the vast majority of the samples being shipped at room-temperature - For a study where some samples were incorrectly collected or processed somehow (as was brought up as an example problematic scenario in this morning's meeting), mention which samples are bad (or refer to the sample mapping/metadata info, e.g. "the samples where is_sample_terrible is YEAH should be filtered out of downstream analyses") - For a study with metadata column names that are hard to interpret in isolation, give explanations for what these columns mean (e.g. "the is_a_cool_dude metadata column is YES for samples where the host's name is Antonio, and PROBABLY NOT for all other examples") I think esp. the bloom filter example would make this sort of feature valuable. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#2952>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAPL3AET66ZICFDOUOJUOJLQODAG3ANCNFSM4I7454FA> .

-- Gail Ackermann Knight Lab UCSD glackermann@ucsd.edu <ackermag@ucsd.edu>

[antgonza]

Hi @fedarko and @ackermag; just to confirm, would a single large text entry would satisfy this? Does it need to be rich (for example, https://mindmup.github.io/bootstrap-wysiwyg/) or would plain text work? Thanks.

[ackermag]

I think plain test works fine - like a "READ ME" statement

…

On Mon, Dec 2, 2019 at 8:52 AM Antonio Gonzalez ***@***.***> wrote: Hi @fedarko <https://github.com/fedarko> and @ackermag <https://github.com/ackermag>; just to confirm, would a single large text entry would satisfy this? Does it need to be rich (for example, https://mindmup.github.io/bootstrap-wysiwyg/) or would plain text work? Thanks. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#2952>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAPL3AGTR46UVSTLQRZDWADQWU4OJANCNFSM4I7454FA> .

-- Gail Ackermann Knight Lab UCSD glackermann@ucsd.edu <ackermag@ucsd.edu>