galaxyproject / galaxyproject/galaxy_codex

RSE keys don't look very stable

Open
#260 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
28
Forks
36
Avg merge
19h 29m
Merged PRs (30d)
1

Description

The data that is exported to RSE "looks" a bit scary. See for example: https://github.com/research-software-ecosystem/content/blob/master/data/abricate/abricate.galaxy.json

Those data are meant to be parsed by scripts to do fancy stuff. However, if the keys change frequently over time, this can become cumbersome.

I guess the keys in this file do match 1:1 to column names? Would it be better to map column names to some more stable entities, so that you can change column names but don't change the export?

If not, can we maybe change the column names to no include `()` and such. E.g. convert `"No._of_tool_users_(all_time)_(usegalaxy.org.au)":` to `"no_of_tool_users_all_time_usegalaxy.org.au":`?
All lower case would also help :)

Contributor guide

Open the contributing guide

Research direction

Begin with data/abricate/abricate.galaxy.json and compare its RSE keys with the source column names. Trace how the export is produced, decide whether stable mapping or normalized keys is the intended scope, and define completion as a documented, consistent key policy demonstrated in the example.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.