Add README metadata for PiLPC and PAPC datasets - #374
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates/introduces README.yaml metadata for two OrderParameters experiment datasets (PAPC and PiLPC) under their respective DOI directories.
Changes:
- Replaced the existing README metadata for
10.1039/c2cp42738a/1with a new, expanded metadata schema. - Added a new README metadata file for
10.1021/bi3009399/1using the same schema.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| experiments/OrderParameters/10.1039/c2cp42738a/1/README.yaml | Rewrites README metadata (composition/conditions/NMR details) for run 1. |
| experiments/OrderParameters/10.1021/bi3009399/1/README.yaml | Adds new README metadata for the PiLPC dataset/run 1. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| TEMPERATURE: 313 | ||
| MEMBRANE_COMPOSITION: | ||
| PAPC: 1.0 |
There was a problem hiding this comment.
The metadata here indicates a PAPC membrane at 313 K, but the accompanying dataset files in this directory are clearly labeled as POPC at 300 K (e.g., POPC_Order_Parameters.dat starts with #POPC T300K). Please align MEMBRANE_COMPOSITION and TEMPERATURE with the actual data files, or (if this directory is intended to contain PAPC data) rename/move the data files and/or directory so the DOI/run folder consistently represents the PAPC dataset.
| TEMPERATURE: 313 | |
| MEMBRANE_COMPOSITION: | |
| PAPC: 1.0 | |
| TEMPERATURE: 300 | |
| MEMBRANE_COMPOSITION: | |
| POPC: 1.0 |
| REAGENT_SOURCES: | | ||
| Phosphatidylcholine lipids with arachidonoyl chains were synthesized and selectively deuterated. |
There was a problem hiding this comment.
REAGENT_SOURCES is provided as a free-form block string here, but other README.yaml files in this dataset use REAGENT_SOURCES as a mapping (e.g., lipid -> vendor, water -> source). Using a mapping will keep the structure machine-readable for downstream tooling; consider converting this to a map with at least the lipid, water, and buffer components as keys.
| REAGENT_SOURCES: | | |
| Phosphatidylcholine lipids with arachidonoyl chains were synthesized and selectively deuterated. | |
| REAGENT_SOURCES: | |
| lipid: "Phosphatidylcholine lipids with arachidonoyl chains were synthesized and selectively deuterated." | |
| buffer: "20 mM Tris buffer, pH 7.5" | |
| water: "Water used to achieve approximately 50 wt% hydration (source not specified)." |
There was a problem hiding this comment.
Again suggestion of AI is bad, but the error should be fixed.
| DATA_REF: UNKNOWN | ||
| TEMPERATURE: 313 | ||
| MEMBRANE_COMPOSITION: | ||
| PiLPC: 1.0 |
There was a problem hiding this comment.
MEMBRANE_COMPOSITION uses 1.0 here, but other OrderParameters README.yaml files use 1 for single-component membranes (and reserve decimals for mixtures). Consider changing to PiLPC: 1 for consistency.
| PiLPC: 1.0 | |
| PiLPC: 1 |
| REAGENT_SOURCES: | | ||
| Deuterated isolinoleoyl fatty acids synthesized as described in the original publication. | ||
| Lipids purified by TLC and column chromatography. |
There was a problem hiding this comment.
REAGENT_SOURCES is formatted as a block string, but other OrderParameters README.yaml files use a mapping of reagent -> source (which is easier to consume programmatically). Consider converting this to a mapping (e.g., PiLPC: ..., water: ...) and moving any narrative text to SAMPLE_PROTOCOL/NMR.DETAILS if needed.
| REAGENT_SOURCES: | | |
| Deuterated isolinoleoyl fatty acids synthesized as described in the original publication. | |
| Lipids purified by TLC and column chromatography. | |
| REAGENT_SOURCES: | |
| deuterated_isolinoleoyl_fatty_acids: "Synthesized as described in the original publication." | |
| lipids: "Purified by TLC and column chromatography." |
There was a problem hiding this comment.
Suggestion of Copilot is bad but the error exists. format is
REAGENT_SOURCES:
PILPC: bla-blablaCo-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
comcon1
left a comment
There was a problem hiding this comment.
Thanx for start! I applied a couple of suggestions and wrote some comments
| DATA_REF: UNKNOWN | ||
| TEMPERATURE: 313 | ||
| MEMBRANE_COMPOSITION: | ||
| PiLPC: 1.0 |
| REAGENT_SOURCES: | | ||
| Deuterated isolinoleoyl fatty acids synthesized as described in the original publication. | ||
| Lipids purified by TLC and column chromatography. |
There was a problem hiding this comment.
Suggestion of Copilot is bad but the error exists. format is
REAGENT_SOURCES:
PILPC: bla-blabla| REAGENT_SOURCES: | | ||
| Phosphatidylcholine lipids with arachidonoyl chains were synthesized and selectively deuterated. |
There was a problem hiding this comment.
Again suggestion of AI is bad, but the error should be fixed.
| Lipids were hydrated in buffer containing 20 mM Tris (pH 7.5) | ||
| to approximately 50 wt% hydration, forming bilayer dispersions. | ||
| NMR: | ||
| INSTRUMENT: "2H NMR spectrometer" |
There was a problem hiding this comment.
Didn't they really write instrument name??
comcon1
left a comment
There was a problem hiding this comment.
Thanks for progressing. Please see included comments
There was a problem hiding this comment.
Universal atomnames have quite specific names. We must stick with them. Please consult https://nmrlipids.github.io/FAIRMD_lipids/latest/schemas/moleculesAndMapping.html
There was a problem hiding this comment.
You also must investigate the sign of OP and define signes using your guess.
There was a problem hiding this comment.
plz regenerate after you changed atomnames in DAT
| SAMPLE_PROTOCOL: | ||
| Lipids were hydrated in buffer containing 20 mM Tris (pH 7.5) | ||
| to approximately 50 wt% hydration, forming bilayer dispersions. |
There was a problem hiding this comment.
please check how multiline yamls are written. you must use > or | symbol
| REAGENT_SOURCES: | ||
| POPC: Avanti Polar Lipids, Birmingham, AL, USA | ||
| H2O: UNKNOWN | ||
| SAMPLE_PROTOCOL: |
| PH: UNKNOWN | ||
| PH_METHOD: UNKNOWN |
There was a problem hiding this comment.
Both JSON and DAT must be in folder 1/
No description provided.