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

[Docs] Use contracts for removing sheets #107

Closed
HLWeil opened this issue Jun 6, 2023 · 2 comments
Closed

[Docs] Use contracts for removing sheets #107

HLWeil opened this issue Jun 6, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@HLWeil
Copy link
Member

HLWeil commented Jun 6, 2023

Currently, the Update contracts are designed in a way to minimize user information loss.

The reasoning is as follows:
-> The datamodel does not represent every information stored in the filesystem (Like styling in xlsx files).
-> So when the user makes some changes to the assay portion of the datamodel and updates their filessystem, not the whole assay file should be overwritten
-> Instead, only those portions specified in the new spreadsheet should be updated (namely the annotation tables)

But what happens, when the user deletes parts in the datamodel that are equivalent to one sheet in the assayfile (e.g. the growth protocol)? Somehow this deletion should also happen in the filesystem, otherwise the user will be surprised to find this annotation table again in the datamodel next time they read the arc.


One possible solution: Make it a rule to delete all annotationTables that are not included in the updated spreadsheet.

@HLWeil HLWeil added the documentation Improvements or additions to documentation label Jun 6, 2023
@Freymaurer Freymaurer added this to the ARCtrl milestone Jul 14, 2023
@HLWeil
Copy link
Member Author

HLWeil commented Aug 3, 2023

Removed duplicate issue #122

@Freymaurer:

Related: fslaborg/FsSpreadsheet#30

We need to update only ISA changes, without touching any other user content. Therefore we must establish a system to handle this.

For UPDATE contracts we MUST pass all Tables and the metadata sheet. Any table not passed MUST be deleted, any table passed MUST be updated if changed. The metadata sheet passed MUST be updated if changed.

The exact replacement/update of tables MUST be handled/implemented by the specific IO arctrl implementation.

@Freymaurer
Copy link
Collaborator

This will postponed into the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants