Create a config to remove UNF from sample citations
Open
Nobody has claimed this yet.
Component: JSF
Feature: Metadata
Type: Suggestion
User Role: Depositor
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 564
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 29
Description
Following up on discussion here:
https://groups.google.com/g/dataverse-community/c/UD3k8r8RdVE
From that discussion:
Reasons for retiring UNF
- Standardization: UNF is only used by Dataverse repositories. As far as I know, no other repository uses it and UNF (or other hashes) are not included in recommended citations as described by Datacite or the RDA data citation working group
- Limited use: UNF applies principally to numeric, tabular data. An increasing amount of data are not that -- this is obviously true for QDR-type qualitative data, but also applies to JSON, GIS-data, all sorts of imaging formats such as MRI data, etc.
- False security: Since UNF only applies to tabular files, it gives a false sense of security: a dataset could, e.g., be missing an entire (non-tabular) file or have a scale description reversed in the codebook and still show up with the same UNF
Implementation details
- this should be a configuration; I'd suggest having UNF turned off by default for the reasons above, but installations may have good reasons to keep it
- As per @mercecrosas argument, the change should only apply to new datasets, as removing UNF's from existing sample citations may cause confusion. Two margin cases to consider
- What about datasets currently in Draft?
- What about datasets that are being updated
I think the cleanest solution for both of these is to keep the UNF's, so that the config simply turns UNF off for any newly initiated dataset
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing how sample citations are generated and where configuration for newly initiated datasets is defined. Done means a configuration defaults UNF off, allows installations to enable it, and preserves UNFs for existing, draft, or updated datasets as described in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100