Feature Request: Make dictionary downloadable

[kcullion]

From Hardeep on June 23, 2022
I had a question from a data submitter asking if we can make the dictionary available in Excel format. I think it would be too difficult to make it available in Excel format because some of the controlled terminology lists are quite long and wouldn't even fit in a cell (ie. adverse_events is ~800 terms long). But I was wondering if we had plans to make it available in PDF format?

Possible Implementation

We had a "details" download button in the mockup when first designing this feature: https://zpl.io/b6xPAGW
This was intended to download the entire table and the details.

Let's find out

• How do Data submitters want to use this type of download?
• What would be the best format for download?
• If the user filters the table, would that affect the download content?
• Make sure to include the dictionary version in the download name so they know what version their download is referring to

[hknahal]

Here is the feedback from the user requesting this feature when asked how they plan to use an Excel version of the dictionary:

We created our own RedCap database based off a prior ARGO data dictionary version and are using an Excel document to ensure the RedCap fields are properly aligned with the current ARGO data dictionary version. We’ll continue to use the document to keep track of changes made with future versions. The .tsv’s can definitely be used to create this, but it would be faster to download a single file for the data dictionary. Field & Description, Data Tier, and Attributes would be most helpful, then Type and Permissible Values if possible.

Issues to consider:

• Excel imposes a character limit on a cell, so it will not be possible to include controlled terminologies that are quite long (ie. primary_site, adverse_events, pathological_stage_group).
• This could potentially mean Excel files of different versions of the dictionary floating around. Ideally we want users to always refer to https://docs.icgc-argo.org/dictionary for the most up-to-date dictionary content.
• We'll have to maintain/update code for generating Excel file whenever we release a new dictionary.