Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
3c71d24
LLM TXT added to repo
ypriverol Feb 7, 2026
b2d90c7
Add PDF specification v1.1.0-dev
github-actions[bot] Feb 7, 2026
34563ba
Major changes
ypriverol Feb 7, 2026
63061d8
Merge branch 'dev' of https://github.com/bigbio/proteomics-sample-met…
ypriverol Feb 7, 2026
32c2ecf
Add PDF specification v1.1.0-dev
github-actions[bot] Feb 7, 2026
567e2ef
update with feature_lifecycle document
noatgnu Feb 7, 2026
aabec09
remove feature_lifecycle_document
noatgnu Feb 7, 2026
1743155
Add PDF specification v1.1.0-dev
github-actions[bot] Feb 7, 2026
6b5ee75
Add precursor mass range and charge range columns to DDA template
jonasscheid Feb 9, 2026
e438538
fix link to template being wrongly make from this repo instead of the…
noatgnu Feb 20, 2026
555277c
update changelog link to correct one in master
noatgnu Feb 20, 2026
aad24e2
Merge pull request #799 from bigbio/fix-template-links
ypriverol Feb 21, 2026
ffccf64
Add PDF specification v1.1.0-dev
github-actions[bot] Feb 21, 2026
159e55e
Update README.md
ypriverol Feb 21, 2026
fb82cfa
Add PDF specification v1.1.0-dev
github-actions[bot] Feb 21, 2026
cf91d21
fix broken link and inconsistency in various adoc
noatgnu Feb 21, 2026
9747668
Update VERSIONING.adoc
noatgnu Feb 22, 2026
40d44ed
Replace precursor mass/charge range with min/max columns for mz, char…
jonasscheid Feb 22, 2026
5641524
Merge pull request #800 from bigbio/fix-hyperlink-inconsistency
ypriverol Feb 22, 2026
938c540
Add PDF specification v1.1.0-dev
github-actions[bot] Feb 22, 2026
14f748e
Merge pull request #796 from jonasscheid/feature/dda-precursor-columns
ypriverol Feb 22, 2026
606e209
Add PDF specification v1.1.0-dev
github-actions[bot] Feb 22, 2026
0e37653
Update README.md
ypriverol Feb 22, 2026
b8c34c5
Add PDF specification v1.1.0-dev
github-actions[bot] Feb 22, 2026
3a98718
Update sdrf-proteomics/VERSIONING.adoc
ypriverol Feb 22, 2026
8f00b2c
Add PDF specification v1.1.0-dev
github-actions[bot] Feb 22, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ site/sdrf-data.json
# Claude Code #
###############
.claude/
CLAUDE.md
.codacy/

# Local files for developers are in folder in local-info
Expand Down
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Proteomics Sample Metadata Format

[![Version](https://flat.badgen.net/static/sdrf-proteomics/1.0.1/orange)](CHANGELOG.md)
[![License](https://flat.badgen.net/github/license/bigbio/proteomics-metadata-standard)](https://github.com/bigbio/proteomics-metadata-standard/blob/master/LICENSE)
[![Open Issues](https://flat.badgen.net/github/open-issues/bigbio/proteomics-metadata-standard)](https://github.com/bigbio/proteomics-metadata-standard/issues)
[![Open PRs](https://flat.badgen.net/github/open-prs/bigbio/proteomics-metadata-standard)](https://github.com/bigbio/proteomics-metadata-standard/pulls)
![Contributors](https://flat.badgen.net/github/contributors/bigbio/proteomics-metadata-standard)
![Watchers](https://flat.badgen.net/github/watchers/bigbio/proteomics-metadata-standard)
![Stars](https://flat.badgen.net/github/stars/bigbio/proteomics-metadata-standard)
[![License](https://flat.badgen.net/github/license/bigbio/proteomics-sample-metadata)](https://github.com/bigbio/proteomics-sample-metadata/blob/master/LICENSE)
[![Open Issues](https://flat.badgen.net/github/open-issues/bigbio/proteomics-sample-metadata)](https://github.com/bigbio/proteomics-sample-metadata/issues)
[![Open PRs](https://flat.badgen.net/github/open-prs/bigbio/proteomics-sample-metadata)](https://github.com/bigbio/proteomics-sample-metadata/pulls)
![Contributors](https://flat.badgen.net/github/contributors/bigbio/proteomics-sample-metadata)
![Watchers](https://flat.badgen.net/github/watchers/bigbio/proteomics-sample-metadata)
![Stars](https://flat.badgen.net/github/stars/bigbio/proteomics-sample-metadata)
[![llms.txt](https://flat.badgen.net/static/llms.txt/available/blue)](llms.txt)

## Improving metadata annotation of Proteomics datasets

Expand Down Expand Up @@ -44,7 +45,7 @@ In the [annotated projects](https://github.com/bigbio/proteomics-metadata-standa
Annotate a dataset in 5 steps:

- Read the [SDRF-Proteomics specification](https://github.com/bigbio/proteomics-metadata-standard/tree/master/sdrf-proteomics).
- Depending on the type of dataset, choose the appropriate [sample template](https://github.com/bigbio/proteomics-metadata-standard/tree/master/sdrf-proteomics#sdrf-templates).
- Depending on the type of dataset, choose the appropriate [sample template](https://github.com/bigbio/proteomics-sample-metadata/tree/master/sdrf-proteomics#sdrf-templates).
- Annotate the corresponding ProteomeXchange PXD dataset following the guidelines.
- Validate your SDRF file:

Expand Down
121 changes: 121 additions & 0 deletions llms.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# SDRF-Proteomics

> SDRF-Proteomics is a HUPO-PSI community standard defining a tab-delimited file format for capturing sample-to-data-file relationships in proteomics experiments. It standardizes sample metadata (organism, disease, tissue), technical metadata (instrument, labels, enzymes), and experimental design (factor values) to enable automated reprocessing and reuse of public proteomics datasets. Compatible with MAGE-TAB SDRF from transcriptomics.

## Specification

- sdrf-proteomics/README.adoc - Core specification: format rules, column headers, cell values, templates, factor values, ontologies
- sdrf-proteomics/quickstart.adoc - Quick Start Tutorial (10-15 min)
- sdrf-proteomics/metadata-guidelines/sample-metadata.adoc - Sample Metadata Guidelines: age, sex, disease, organism part, cell type
- sdrf-proteomics/metadata-guidelines/template-definitions.adoc - Template Definitions Guide (for developers)
- sdrf-proteomics/metadata-guidelines/sdrf-terms.tsv - SDRF Terms Reference: all column terms with ontology mappings

- sdrf-proteomics/VERSIONING.adoc - Versioning and Deprecation Policy: version tracks, template compatibility, deprecation lifecycle, transition timelines
- sdrf-proteomics/open-issues.adoc - Open Issues and Future Decisions: community discussions for post-v1.1.0 changes
- psi-document/v1.0.0/SDRF_Proteomics_Specification_v1.0.0.pdf - Official HUPO-PSI specification (PDF, v1.0.0)
- psi-document/v1.1.0-dev/sdrf-proteomics-specification-v1.1.0-dev.pdf - Development specification (PDF, v1.1.0-dev)

## Templates

- sdrf-proteomics/templates/ms-proteomics/README.adoc - MS-Proteomics: labels, instruments, modifications, cleavage agents
- sdrf-proteomics/templates/affinity-proteomics/README.adoc - Affinity Proteomics: Olink and SomaScan
- sdrf-proteomics/templates/human/README.adoc - Human: disease, age, sex, ancestry, disease staging
- sdrf-proteomics/templates/vertebrates/README.adoc - Vertebrates: mouse, rat, zebrafish
- sdrf-proteomics/templates/invertebrates/README.adoc - Invertebrates: Drosophila, C. elegans
- sdrf-proteomics/templates/plants/README.adoc - Plants: Arabidopsis, crops
- sdrf-proteomics/templates/cell-lines/README.adoc - Cell Lines: Cellosaurus integration
- sdrf-proteomics/templates/dda-acquisition/README.adoc - DDA Acquisition: dissociation method, collision energy
- sdrf-proteomics/templates/dia-acquisition/README.adoc - DIA Acquisition: scan windows, isolation width
- sdrf-proteomics/templates/single-cell/README.adoc - Single-Cell Proteomics: cell isolation, carrier proteome
- sdrf-proteomics/templates/immunopeptidomics/README.adoc - Immunopeptidomics: MHC class, HLA typing
- sdrf-proteomics/templates/crosslinking/README.adoc - Crosslinking MS: crosslinker reagents
- sdrf-proteomics/templates/metaproteomics/README.adoc - Metaproteomics: environmental and microbiome samples
- sdrf-proteomics/templates/olink/README.adoc - Olink: proximity extension assays
- sdrf-proteomics/templates/somascan/README.adoc - SomaScan: aptamer-based proteomics

## Template YAML Schemas (sdrf-templates submodule)

Machine-readable YAML definitions used by sdrf-pipelines for validation. Each template has a `.yaml` schema and an optional `.sdrf.tsv` example file. Templates follow a layered hierarchy: base → technology → sample/experiment.

- sdrf-proteomics/sdrf-templates/templates.yaml - Template manifest: all templates with latest versions, inheritance, and layer metadata
- sdrf-proteomics/sdrf-templates/base/1.1.0/base.yaml - Base template (internal, not user-facing): shared columns inherited by all templates
- sdrf-proteomics/sdrf-templates/base/1.1.0/base.sdrf.tsv - Base example
- sdrf-proteomics/sdrf-templates/ms-proteomics/1.1.0/ms-proteomics.yaml - MS-Proteomics (technology layer): minimum valid template for any MS experiment
- sdrf-proteomics/sdrf-templates/ms-proteomics/1.1.0/ms-proteomics.sdrf.tsv - MS-Proteomics example
- sdrf-proteomics/sdrf-templates/affinity-proteomics/1.1.0/affinity-proteomics.yaml - Affinity Proteomics (technology layer): Olink, SomaScan base
- sdrf-proteomics/sdrf-templates/affinity-proteomics/1.1.0/affinity-proteomics.sdrf.tsv - Affinity Proteomics example
- sdrf-proteomics/sdrf-templates/human/1.1.0/human.yaml - Human (sample layer): disease, age, sex, ancestry
- sdrf-proteomics/sdrf-templates/human/1.1.0/human.sdrf.tsv - Human example
- sdrf-proteomics/sdrf-templates/vertebrates/1.1.0/vertebrates.yaml - Vertebrates (sample layer): mouse, rat, zebrafish, etc.
- sdrf-proteomics/sdrf-templates/vertebrates/1.1.0/vertebrates.sdrf.tsv - Vertebrates example
- sdrf-proteomics/sdrf-templates/invertebrates/1.1.0/invertebrates.yaml - Invertebrates (sample layer): Drosophila, C. elegans
- sdrf-proteomics/sdrf-templates/invertebrates/1.1.0/invertebrates.sdrf.tsv - Invertebrates example
- sdrf-proteomics/sdrf-templates/plants/1.1.0/plants.yaml - Plants (sample layer): Arabidopsis, crops
- sdrf-proteomics/sdrf-templates/plants/1.1.0/plants.sdrf.tsv - Plants example
- sdrf-proteomics/sdrf-templates/cell-lines/1.1.0/cell-lines.yaml - Cell Lines (experiment layer): Cellosaurus integration
- sdrf-proteomics/sdrf-templates/cell-lines/1.1.0/cell-lines.sdrf.tsv - Cell Lines example
- sdrf-proteomics/sdrf-templates/dda-acquisition/1.1.0/dda-acquisition.yaml - DDA Acquisition (experiment layer): dissociation method, collision energy
- sdrf-proteomics/sdrf-templates/dda-acquisition/1.1.0/dda-acquisition.sdrf.tsv - DDA example
- sdrf-proteomics/sdrf-templates/dia-acquisition/1.1.0/dia-acquisition.yaml - DIA Acquisition (experiment layer): scan windows, isolation width
- sdrf-proteomics/sdrf-templates/dia-acquisition/1.1.0/dia-acquisition.sdrf.tsv - DIA example
- sdrf-proteomics/sdrf-templates/crosslinking/1.1.0/crosslinking.yaml - Crosslinking MS (experiment layer): crosslinker reagents
- sdrf-proteomics/sdrf-templates/crosslinking/1.1.0/crosslinking.sdrf.tsv - Crosslinking example
- sdrf-proteomics/sdrf-templates/single-cell/1.0.0/single-cell.yaml - Single-Cell (experiment layer): cell isolation, carrier proteome
- sdrf-proteomics/sdrf-templates/single-cell/1.0.0/single-cell.sdrf.tsv - Single-Cell example
- sdrf-proteomics/sdrf-templates/immunopeptidomics/1.0.0-dev/immunopeptidomics.yaml - Immunopeptidomics (experiment layer): MHC class, HLA typing
- sdrf-proteomics/sdrf-templates/metaproteomics/1.0.0-dev/metaproteomics.yaml - Metaproteomics (experiment layer): environmental and microbiome samples
- sdrf-proteomics/sdrf-templates/metaproteomics/1.0.0-dev/metaproteomics.sdrf.tsv - Metaproteomics example
- sdrf-proteomics/sdrf-templates/olink/1.0.0/olink.yaml - Olink (experiment layer): proximity extension assays
- sdrf-proteomics/sdrf-templates/olink/1.0.0/olink.sdrf.tsv - Olink example
- sdrf-proteomics/sdrf-templates/somascan/1.0.0/somascan.yaml - SomaScan (experiment layer): aptamer-based proteomics
- sdrf-proteomics/sdrf-templates/somascan/1.0.0/somascan.sdrf.tsv - SomaScan example

## Tools

- sdrf-proteomics/tool-support.adoc - Tool Support Overview: annotators, validators, analysis tools
- https://github.com/bigbio/sdrf-pipelines - sdrf-pipelines: official Python CLI/library for SDRF validation
- https://lessdrf.streamlit.app/ - lesSDRF: web-based SDRF creation tool
- https://cupcake-vanilla-demo.proteo.nexus/ - CupCAKE: web annotation platform with ontology integration
- https://quantms.org/ - quantms: Nextflow pipeline for quantitative proteomics
- https://www.maxquant.org/ - MaxQuant: desktop proteomics software with SDRF export
- https://github.com/wombat-p - Wombat-P: benchmarking platform for proteomics workflows

## Examples

- examples/core/PXD002137/PXD002137.sdrf.tsv - Core example: label-free
- examples/core/PXD004684/PXD004684.sdrf.tsv - Core example: TMT labeled
- examples/core/PXD006482/PXD006482.sdrf.tsv - Core example: SILAC
- examples/core/PXD008934/PXD008934.sdrf.tsv - Core example: human proteome
- examples/core/PDC000126/PDC000126.sdrf.tsv - Core example: PDC dataset
- examples/use-cases/crosslinking.sdrf.tsv - Use case: crosslinking MS
- examples/use-cases/immunopeptidomics.sdrf.tsv - Use case: immunopeptidomics
- examples/use-cases/single-cell.sdrf.tsv - Use case: single-cell proteomics

## Annotated Projects

- annotated-projects/ - 250+ public proteomics datasets annotated in SDRF format
- annotated-projects/PXD008934/PXD008934.sdrf.tsv - Label-free quantification
- annotated-projects/PXD017710/PXD017710.sdrf.tsv - TMT-labeled quantitative proteomics
- annotated-projects/PXD000612/PXD000612.sdrf.tsv - SILAC-based quantification
- annotated-projects/PXD018830/PXD018830-DIA.sdrf.tsv - Data-independent acquisition
- annotated-projects/PXD000759/PXD000759.sdrf.tsv - Phosphoproteomics
- annotated-projects/PXD001819/PXD001819.sdrf.tsv - Cell line proteomics

## Publications

- https://www.nature.com/articles/s41467-021-26111-3 - Dai et al. (2021) Nat Commun: A proteomics sample metadata representation for multiomics integration
- https://pubs.acs.org/doi/abs/10.1021/acs.jproteome.0c00376 - Perez-Riverol et al. (2020) J Proteome Res: Towards a sample metadata standard in public proteomics repositories

## Project

- README.md - Project overview and contributor list
- CHANGELOG.md - Version history and changes
- CITATION.cff - Citation metadata
- LICENSE - GNU General Public License
- DEVELOPMENT.md - Building the documentation website locally

## Optional

- https://github.com/bigbio/proteomics-metadata-standard/wiki - 30-Minute Guide to SDRF-Proteomics
- https://www.youtube.com/watch?v=TMDu_yTzYQM - Introduction to SDRF-Proteomics (video)
- https://www.psidev.info/sdrf-sample-data-relationship-format - HUPO-PSI official page
Binary file modified psi-document/sdrf-proteomics-specification-v1.1.0-dev.pdf
Binary file not shown.
2 changes: 2 additions & 0 deletions sdrf-proteomics/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ The file is organized into three column sections:

The SDRF-Proteomics specification uses https://semver.org/[Semantic Versioning] (MAJOR.MINOR.PATCH). Version numbers are prefixed with "v" (e.g., v1.1.0). Changes are proposed via GitHub pull requests to the dev branch.

For the complete versioning strategy — including template versioning, ontology updates, the deprecation policy, transition timelines, and migration tooling — see link:VERSIONING.adoc[Versioning and Deprecation Policy].

[[sdrf-file-rules]]
=== Format rules

Expand Down
Loading