EnzymeML / PyEnzyme

🧬 - Data management and modeling framework based on EnzymeML.
BSD 2-Clause "Simplified" License
21 stars 9 forks source link

Enzyme ML spreadsheets should support 96 Well-plate design #59

Open Vanry7 opened 1 year ago

Vanry7 commented 1 year ago

Many experiments are run in 96-WP, so having an excel worksheet to organise them would be great. See attached my first draft, mainly for general organisation idea.

96WP- Endpoint-V0.1.1.xlsm.zip

haeussma commented 1 year ago

EnzymeML template 96WP draft.xlsm.zip Hi @Vanry7, I looked into your draft and made some modifications. I think we should keep the template as clean as possible. It should only serve as a template to enter data. Thus, no calculations should be done within the spreadsheet. I modified your "ReactantTemplate" and "ProteinTemplate" sheets. I think they should be hidden, yet be used in the background by a Visual Basic script. The script should then:

Then, the initial concentration of each specified reactant can be specified in the respective"ReactantTemplate" in the familiar 96well format.

The same applies for different proteins.

Vanry7 commented 1 year ago

Hi, Following the previous discussion and meeting, here is an updated version of the notebook.

Major updates includes:

The things left to do:

As a side note, creating another sheet dedicated to the meta-data of protein expression, that could then be linked to this one (adding for instance a column in "proteins", to fill-in the sheet name) would make the collection and storage of meta data truly complete.

EnzymeML template 96WP draft-0.1.4.xlsm.zip

Vanry7 commented 1 year ago

Hi, Everything has been updated, both visually and in design to make it more reliable and user-friendly.

Find attached the finished file.

EnzymeML template 96WP draft-0.2.2.xlsm.zip

haeussma commented 1 year ago

Just finished edited EnzymeML template 96WP draft-0.2.4.xlsm.zip. Added a sheet in which the initial pH can be specified for each well individually. Additionally, I reworked the 'Read Me' sheet and added instructions on how to fill in the spreadsheet and how to convert the spreadsheet to a valid EnzymeML document.

Furthermore, I wrote a parser function for the new spreadsheed template, which is used by the class method fromTemplate() of EnzymeMLDocument.

EgonHeuson commented 1 year ago

Hello guys, Finally I found the time to work on this. This template is amazingly done! I just allowed myself to propose a v0.2.5, which corrects few bugs from v0.2.4 (mainly data validation issue leading to cells that users could not fill in). I also corrected the format of the units to make it compliant with international writing, and colored additional cells to be more compliant to the documentation on the first page. Finally, I also added a conversion tool to allow people that get "plate shape" data out of their plate reader, to transform them in to the required list in the "Data" sheet (by the way column G1 to H12 were missing in sheet "Data"). And I finally added a graph generation tool to help the user to quickly visualize their results. Could you let me know (if) what else needs to be done on the sheet to make it readily compatible with the EnzymeMLDocument? Congrats again for this amazing template! i'll use it to encode all the data from my test dataset and see how it goes.

EnzymeML template 96WP draft-0.2.5.xlsm.zip

EgonHeuson commented 1 year ago

Hey! New 0.2.6 version with quick correction accorded to Max's request (temperature units and suppression of the "other" option in the possibilities).

EnzymeML template 96WP draft-0.2.6.xlsm.zip

haeussma commented 1 year ago

Hey! Looked at 0.2.6. I really like the conversion tool from plate "snapshots" to list data for each well! I cleaned up the sheet and added a description to the read me section. I also changed the color in ProteinTemplate and ChemicalTemplate, since some cells were randomly colored. These changes are in EnzymeML template 96WP draft-0.2.7.xlsm.zip. In the next days, I will adjust the spreadsheet reader of pyenzyme to accommodate the changes. After writing tests, we can merge the new functionalities into main.

EgonHeuson commented 1 year ago

Great!! :-D

Vanry7 commented 11 months ago

Hi ! Just got the time to look at the last updates, it looks really great ! I'll present it to my group during our next training school so we can start to tinker with it and get some return from users

JR-1991 commented 9 months ago

Is this issue resolved by now? If so, happy to close it 😊