search

nfdi4plants / ARCitect

Cross-platform app to create and manage ARCs.
9 stars 6 forks source link

[BUG] Linking assays to studies #243

Closed shiltemann closed 2 months ago

shiltemann commented 2 months ago

OS and framework information (please complete the following information):

Describe the bug I was trying to link my assays to a study, but could not figure out how to do it.

In the documentation, it is stated to select a study when you create an assay, but this option no longer appears in the new assay dialogue. Furthermore, I created my assays before my study, so I would have needed a way to do this after creation of the assay.

I would have expected a "study" field on the assay's main metadata page/table (or an "assays" field on the study metadata page) where this could be set.

Not sure if this is a bug, or if there is just a different way of doing things now and it's just a matter of updating the documentation to match, but I ran into this issue today and was unsure how to proceed.

Seems to have changed in ARCitect v0.0.36

Freymaurer commented 2 months ago

This is optional. We decided to use implicit references in ARCitect. This means if you use any node from any assay as part of a study, the assay will autoamtically be part of the study.

This decision is based on merge conflicts on .xlsx files. Picture the following situation. Two people working on one ARC, both add one assay. If the assay is explicitly referenced in the related study file, they will run into merge conflicts. With implicit references only the respective assay.xlsx is updated and the users will encounter no merge conflicts.

shiltemann commented 2 months ago

ok cool, makes a lot of sense, and great that it's now autodetected so to speak.

So by "use any node of an assay as part of a study", do you mean e.g. referencing the same sample identifiers etc? neat :)

Then perhaps removing/updating the section in the documentation is in order? (happy to move this issue or start a PR if useful)

Freymaurer commented 2 months ago

So by "use any node of an assay as part of a study", do you mean e.g. referencing the same sample identifiers etc? neat :)

Exactly! This follows the specification seen here:

Then perhaps removing/updating the section in the documentation is in order? (happy to move this issue or start a PR if useful)

Absolutly, currently a lot is happening for Swate and ARCitect and we are not many people, so it is very likely to find outdated information in the docs 😞 Any help (PRs or even just notifying us of these issues) is more than welcome!

shiltemann commented 2 months ago

ok, will do, and thanks for taking the time to explain things to me!