Skip to content

Add README metadata for PiLPC and PAPC datasets - #374

Closed
AvNeEsH71-iam wants to merge 8 commits into
NMRLipids:mainfrom
AvNeEsH71-iam:clean-metadata-pilpc-papc
Closed

Add README metadata for PiLPC and PAPC datasets#374
AvNeEsH71-iam wants to merge 8 commits into
NMRLipids:mainfrom
AvNeEsH71-iam:clean-metadata-pilpc-papc

Conversation

@AvNeEsH71-iam

Copy link
Copy Markdown
Collaborator

No description provided.

Copilot AI review requested due to automatic review settings March 24, 2026 12:16

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/1 with a new, expanded metadata schema.
  • Added a new README metadata file for 10.1021/bi3009399/1 using 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.

Comment on lines +4 to +6
TEMPERATURE: 313
MEMBRANE_COMPOSITION:
PAPC: 1.0

Copilot AI Mar 24, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
TEMPERATURE: 313
MEMBRANE_COMPOSITION:
PAPC: 1.0
TEMPERATURE: 300
MEMBRANE_COMPOSITION:
POPC: 1.0

Copilot uses AI. Check for mistakes.
Comment thread experiments/OrderParameters/10.1039/c2cp42738a/1/README.yaml Outdated
Comment on lines +13 to +14
REAGENT_SOURCES: |
Phosphatidylcholine lipids with arachidonoyl chains were synthesized and selectively deuterated.

Copilot AI Mar 24, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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)."

Copilot uses AI. Check for mistakes.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again suggestion of AI is bad, but the error should be fixed.

DATA_REF: UNKNOWN
TEMPERATURE: 313
MEMBRANE_COMPOSITION:
PiLPC: 1.0

Copilot AI Mar 24, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
PiLPC: 1.0
PiLPC: 1

Copilot uses AI. Check for mistakes.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please capitalize PILPC

Comment thread experiments/OrderParameters/10.1021/bi3009399/1/README.yaml
Comment on lines +12 to +14
REAGENT_SOURCES: |
Deuterated isolinoleoyl fatty acids synthesized as described in the original publication.
Lipids purified by TLC and column chromatography.

Copilot AI Mar 24, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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."

Copilot uses AI. Check for mistakes.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion of Copilot is bad but the error exists. format is

REAGENT_SOURCES:
   PILPC: bla-blabla

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

@comcon1 comcon1 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanx for start! I applied a couple of suggestions and wrote some comments

DATA_REF: UNKNOWN
TEMPERATURE: 313
MEMBRANE_COMPOSITION:
PiLPC: 1.0

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please capitalize PILPC

Comment on lines +12 to +14
REAGENT_SOURCES: |
Deuterated isolinoleoyl fatty acids synthesized as described in the original publication.
Lipids purified by TLC and column chromatography.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion of Copilot is bad but the error exists. format is

REAGENT_SOURCES:
   PILPC: bla-blabla

Comment thread experiments/OrderParameters/10.1039/c2cp42738a/1/README.yaml
Comment on lines +13 to +14
REAGENT_SOURCES: |
Phosphatidylcholine lipids with arachidonoyl chains were synthesized and selectively deuterated.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Didn't they really write instrument name??

@comcon1 comcon1 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for progressing. Please see included comments

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Universal atomnames have quite specific names. We must stick with them. Please consult https://nmrlipids.github.io/FAIRMD_lipids/latest/schemas/moleculesAndMapping.html

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You also must investigate the sign of OP and define signes using your guess.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

plz regenerate after you changed atomnames in DAT

Comment on lines +13 to +15
SAMPLE_PROTOCOL:
Lipids were hydrated in buffer containing 20 mM Tris (pH 7.5)
to approximately 50 wt% hydration, forming bilayer dispersions.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

Comment on lines +20 to +21
PH: UNKNOWN
PH_METHOD: UNKNOWN

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

duplicated fields

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both JSON and DAT must be in folder 1/

@comcon1 comcon1 closed this Apr 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants