Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature Request] Add Assay Description to isa.xlsx #86

Open
andreaschrader opened this issue Dec 14, 2023 · 6 comments · May be fixed by #140
Open

[Feature Request] Add Assay Description to isa.xlsx #86

andreaschrader opened this issue Dec 14, 2023 · 6 comments · May be fixed by #140
Assignees

Comments

@andreaschrader
Copy link
Member

Is your feature request related to a problem? Please describe.
When importing or exporting individual datasets from an ARC, an assay description is desirable and helps for interoperability.

Describe the solution you'd like
Add "Study Assay Description" to the isa.assay.xlsx file and update to study and investigation.

@HLWeil
Copy link
Member

HLWeil commented Dec 22, 2023

This is also stemming from the fact that Assays contain no description field in neither ISA-Tab nor ISA-Json. Will move this issue to specification.

@HLWeil HLWeil transferred this issue from nfdi4plants/ARCCommander Dec 22, 2023
@kMutagene kMutagene added this to the ARC-specification v3.0.0 milestone Jun 12, 2024
@kMutagene kMutagene added the Status: Needs Triage This item is up for investigation. label Jun 12, 2024
@HLWeil HLWeil moved this to In discussion in ARCStack Jun 27, 2024
@HLWeil HLWeil removed the Status: Needs Triage This item is up for investigation. label Jun 27, 2024
@HLWeil
Copy link
Member

HLWeil commented Feb 12, 2025

I'd say we just add identifier, description, and title in the assay to to align it with investigation and study? This has been an issue of discussion long enough and compared to some other adjustments we made, this is a very minor abbreviation from the reference ISA-Tab.

  • Update in isa-xlsx specification
  • Should be straight-forward to implement in ARCtrl/Swate
  • Should be straight-forward to put as comments in isa-json
  • Should come naturally in ARC RO-Crate

What do you say?
@Freymaurer @muehlhaus @Brilator

@Freymaurer
Copy link
Contributor

I am all for this change, are these extra fields lost on export to ISA or do we plan anything to keep them?

@Brilator
Copy link
Member

Would it replace or just add to the current assay metadata?

@HLWeil
Copy link
Member

HLWeil commented Feb 13, 2025

I am all for this change, are these extra fields lost on export to ISA or do we plan anything to keep them?

These fields do not contain any hierarchical structure but are just flat strings. So, as stated, it will be very straight-forward to include them in isa-json as comments. By this, you don't lose the information when writing and reading again.

@HLWeil
Copy link
Member

HLWeil commented Feb 13, 2025

Would it replace or just add to the current assay metadata?

It would just add.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In discussion
Development

Successfully merging a pull request may close this issue.

5 participants