Skip to content

Create a new spreadsheet template

marton-balazs-kovacs edited this page Sep 11, 2020 · 1 revision

Main goal

The spreadsheet to be flexible, easy to understand for end-users, and easy to check upon upload.

Related issues

Proposed solutions

  • in certain columns where possible information can be provided authors can write more than one information by using YAML syntax
    • basically writing more information in the cell and divide them by "-" and enter
    • on the backend part we should read it as text and accept all new lines, just "-" and both of them as more entries
  • create a default minimal infosheet template with only the absolutely necessary columns (what should be these columns?)
    • allow users to add more columns if they need it
    • we should also provide a premade list of extra columns to choose from
    • on the backend part, we require users to include the default columns, otherwise, the app returns an error
      • we can have a list of "official" column names that are tested in addition if added but do not throw an error just a warning (e.g. duplicated values in email addresses)
  • change the color of the google sheet template to match the app color scheme
  • provide an option in the app where users can create their infosheet template by choosing extra columns whatsoever and download it locally
    • this way the downloaded template will match our requirements and the user can decide where to share it
  • add the option to create the template using Julien's app

Backend changes needed

  • we need to refer to columns by name and not index
    • preferably using one list of columns names all over the app to be consistent and avoid changes at multiple places (e.g. internal datafile)
  • reading columns with possible multiple values in one cell as text and then transforming the content
  • as currently there is no Rmd template for all the outputs that we create I would not change any output to be YAML based but change the background framework from df to list
    • it would be easy to transform list to YAML or JSON later on
Clone this wiki locally