goci icon indicating copy to clipboard operation
goci copied to clipboard

Investigate an improved process for receiving README files for summary statistics

Open eks-ebi opened this issue 4 years ago • 2 comments

Currently, users are required to enter README text for each set of summary statistics into a single cell in the submission template. This seems to be inconvenient and to cause confusion for users, because:

  1. Users may already have a README file as .txt (and this seems to be the expectation when providing sumstats files in general) - transferring it to the Excel template is an additional step
  2. Users may have README info that exceeds the character limit for that column in Excel (see https://github.com/EBISPOT/goci/issues/214)
  3. README files often contain line breaks for readability - line breaks are difficult when typing directly into the cell (and viewing) in Excel, so users need to write it somewhere else and copy-paste, which can be frustrating

One possibility to investigate is whether README files could be uploaded in a standard text file format via Globus (along with the sumstats files). Users could then enter only the README file name in the template, rather than the full text (note this would reverse ticket https://github.com/EBISPOT/goci/issues/68)

Some things to consider:

  • How to standardise the files - e.g. provide a simple template for users to follow?
  • How much validation do we need to do on these README files?

eks-ebi avatar Sep 24 '20 08:09 eks-ebi

@jdhayhurst assigning you just so you know about it - feel free to put back in general queue etc.

eks-ebi avatar Sep 24 '20 08:09 eks-ebi

outstanding - is it an issue?

jdhayhurst avatar Jul 26 '23 15:07 jdhayhurst