Reporting & Reproducibility (est-reporting-and-reproducibility)
ES&T strongly encourages public data and expects authors to make materials, data, and protocols
available through public databases, with a data-availability statement and a Supporting
Information file submitted alongside the manuscript and reviewed with it. Build these as you go, not
the night before submission.
When to trigger
- Assembling the Supporting Information (SI) PDF/files
- Writing the data-availability statement and choosing repositories
- Depositing data, spectra, sequences, code, and protocols
- Making sure every figure/table can be regenerated from deposited data
What ES&T expects
- Supporting Information. Submitted simultaneously as separate file(s); describe contents and
file type in the SI paragraph (e.g., "Additional analytical methods, calibration data, and NMR
spectra (PDF)"). Available to reviewers; free to readers on publication.
- Data-availability statement. State where the data live and how to access them; cite
accession codes / DOIs.
- Public deposition by data type (see
resources/external_tools.md):
- Sequences → GenBank / ENA / DDBJ; omics/microarray → GEO / ArrayExpress;
proteomics → PRIDE / ProteomeXchange; mass spectra → MassIVE / MetaboLights / MassBank.
- General data/code → Dryad, figshare, Zenodo, OSF.
- Methods reproducibility. Report instrument settings, reagents/standards, QA/QC, and analysis
steps in enough detail to reproduce; deposit analysis code with seeds and pinned versions.
- Restricted data. If data cannot be fully shared (privacy/legal), explain why and give README
instructions on how to obtain it; provide what can be shared.
SI assembly checklist
Deposition routing: data type → repository
ES&T expects deposition in the community-standard repository for each data type, not a generic
catch-all. Reviewers in a sub-field know the canonical home and notice when data are not there
(confirm any volatile mandate against the journal's current author guidelines — 待核实):
| Data type |
Expected repository |
Reviewer's note if missing |
| DNA/RNA sequences |
GenBank / ENA / DDBJ |
not independently checkable |
| Omics / microarray |
GEO / ArrayExpress |
non-standard, hard to reuse |
| Proteomics |
PRIDE / ProteomeXchange |
unverifiable identifications |
| Mass spectra / metabolomics |
MassIVE / MetaboLights / MassBank |
spectra not reusable |
| General data / code |
Dryad, figshare, Zenodo, OSF |
"available on request" red flag |
Worked micro-example (illustrative — SI for a PFAS fate study)
For the river-PFAS study, a reviewer-ready Associated Content package (illustrative) contains:
- SI PDF: extended LC-MS/MS methods, transition list and collision energies, the QA/QC table
(field blanks, 92% recovery, per-analyte LOQ), calibration curves (R² > 0.99, illustrative), and
the ROS censoring detail — each item S-numbered and referenced in order from the main text.
- Deposited: raw and processed concentration tables plus the analysis code (with the random seed
for the bootstrap CI and pinned package versions) on Zenodo with a DOI; the mass spectra on MassIVE.
- Data-availability statement: "Concentration data and analysis code are available at Zenodo
(DOI: 10.xxxx/illustrative); raw mass spectra are deposited at MassIVE (accession: illustrative)."
The test that catches drift: re-run the deposited master script on a clean machine — every figure and
the 2.4 ng/L headline number must regenerate exactly. If they do not, the SI and manuscript have
diverged.
Referee-pushback patterns and the venue-specific fix
- "Data available on request is not sufficient." → Deposit in the type-appropriate repository and
cite the accession/DOI in the statement.
- "Methods not reproducible." → Move instrument settings, standards, and QA/QC into the SI in
enough detail to repeat the work; deposit code with seeds and versions.
- "SI contents not described." → Write the SI paragraph naming each file and its type.
Anti-patterns
- "Data available on request" with no statement, repository, or accession
- An SI that is a dumping ground with no described contents or ordering
- Spectra/sequences/omics not deposited in the expected community database
- Code that does not run, or that cannot regenerate the manuscript's exhibits
- Leaving SI + deposition to submission day, so numbers drift from the manuscript
Output format
【SI contents】described + ordered (S-numbered)? [Y/N]
【Data-availability statement】present with accession/DOI? [Y/N]
【Deposition】data type → repository (GenBank/GEO/PRIDE/MassIVE/Dryad/Zenodo/OSF)
【Code】deposited, seeds + pinned versions, regenerates exhibits? [Y/N]
【Restricted data】justified + README to obtain? [N/A or Y/N]
【Next】est-writing-style
Supplementary resources
Source: brycewang-stanford/Awesome-Journal-Skills → Environmental-Science-and-Technology-Skills/skills/est-reporting-and-reproducibility/SKILL.md
1---2name: est-reporting-and-reproducibility3description: Use when assembling the Supporting Information (SI), data-availability statement, and public-data/code deposit for an Environmental Science & Technology (ES&T) manuscript. ES&T expects materials, data, and protocols to be deposited in public databases and a data-availability statement, with SI submitted alongside the manuscript. It guides reporting and deposit; it does not generate the underlying data.4---5
6
7# Reporting & Reproducibility (est-reporting-and-reproducibility)
8
9ES&T strongly encourages public data and expects authors to make **materials, data, and protocols**
10available through public databases, with a **data-availability statement** and a **Supporting
11Information** file submitted alongside the manuscript and reviewed with it. Build these as you go, not
12the night before submission.
13
14## When to trigger
15
16- Assembling the **Supporting Information (SI)** PDF/files
17- Writing the **data-availability statement** and choosing repositories
18- Depositing data, spectra, sequences, code, and protocols
19- Making sure every figure/table can be regenerated from deposited data
20
21## What ES&T expects
22
231. **Supporting Information.** Submitted simultaneously as separate file(s); describe contents and
24 file type in the SI paragraph (e.g., "Additional analytical methods, calibration data, and NMR
25 spectra (PDF)"). Available to reviewers; free to readers on publication.
262. **Data-availability statement.** State where the data live and how to access them; cite
27 **accession codes / DOIs**.
283. **Public deposition by data type** (see `resources/external_tools.md`):
29 - Sequences → **GenBank / ENA / DDBJ**; omics/microarray → **GEO / ArrayExpress**;
30 proteomics → **PRIDE / ProteomeXchange**; mass spectra → **MassIVE / MetaboLights / MassBank**.
31 - General data/code → **Dryad, figshare, Zenodo, OSF**.
324. **Methods reproducibility.** Report instrument settings, reagents/standards, QA/QC, and analysis
33 steps in enough detail to reproduce; deposit analysis code with seeds and pinned versions.
345. **Restricted data.** If data cannot be fully shared (privacy/legal), explain why and give README
35 instructions on how to obtain it; provide what can be shared.
36
37## SI assembly checklist
38
39- [ ] Extended methods, reagents/standards, instrument parameters
40- [ ] Calibration curves, QA/QC tables (blanks, recoveries, CRMs, LOD/LOQ)
41- [ ] Supplementary figures/tables/spectra referenced in order (Figure S1, Table S1…)
42- [ ] Data-availability statement with accession/DOI
43- [ ] Code/scripts deposited; figures regenerate from deposited data
44- [ ] Page/word limits and file formats per ACS SI guidance (待核实 on specifics)
45
46## Deposition routing: data type → repository
47
48ES&T expects deposition in the *community-standard* repository for each data type, not a generic
49catch-all. Reviewers in a sub-field know the canonical home and notice when data are not there
50(confirm any volatile mandate against the journal's current author guidelines — 待核实):
51
52| Data type | Expected repository | Reviewer's note if missing |
53|-----------|--------------------|-----------------------------|
54| DNA/RNA sequences | GenBank / ENA / DDBJ | not independently checkable |
55| Omics / microarray | GEO / ArrayExpress | non-standard, hard to reuse |
56| Proteomics | PRIDE / ProteomeXchange | unverifiable identifications |
57| Mass spectra / metabolomics | MassIVE / MetaboLights / MassBank | spectra not reusable |
58| General data / code | Dryad, figshare, Zenodo, OSF | "available on request" red flag |
59
60## Worked micro-example (illustrative — SI for a PFAS fate study)
61
62For the river-PFAS study, a reviewer-ready Associated Content package (illustrative) contains:
63
64- **SI PDF:** extended LC-MS/MS methods, transition list and collision energies, the QA/QC table
65 (field blanks, 92% recovery, per-analyte LOQ), calibration curves (R² > 0.99, illustrative), and
66 the ROS censoring detail — each item S-numbered and referenced in order from the main text.
67- **Deposited:** raw and processed concentration tables plus the analysis code (with the random seed
68 for the bootstrap CI and pinned package versions) on Zenodo with a DOI; the mass spectra on MassIVE.
69- **Data-availability statement:** "Concentration data and analysis code are available at Zenodo
70 (DOI: 10.xxxx/illustrative); raw mass spectra are deposited at MassIVE (accession: illustrative)."
71
72The test that catches drift: re-run the deposited master script on a clean machine — every figure and
73the 2.4 ng/L headline number must regenerate exactly. If they do not, the SI and manuscript have
74diverged.
75
76## Referee-pushback patterns and the venue-specific fix
77
78- *"Data available on request is not sufficient."* → Deposit in the type-appropriate repository and
79 cite the accession/DOI in the statement.
80- *"Methods not reproducible."* → Move instrument settings, standards, and QA/QC into the SI in
81 enough detail to repeat the work; deposit code with seeds and versions.
82- *"SI contents not described."* → Write the SI paragraph naming each file and its type.
83
84## Anti-patterns
85
86- "Data available on request" with no statement, repository, or accession
87- An SI that is a dumping ground with no described contents or ordering
88- Spectra/sequences/omics not deposited in the expected community database
89- Code that does not run, or that cannot regenerate the manuscript's exhibits
90- Leaving SI + deposition to submission day, so numbers drift from the manuscript
91
92## Output format
93
94```
95【SI contents】described + ordered (S-numbered)? [Y/N]
96【Data-availability statement】present with accession/DOI? [Y/N]
97【Deposition】data type → repository (GenBank/GEO/PRIDE/MassIVE/Dryad/Zenodo/OSF)
98【Code】deposited, seeds + pinned versions, regenerates exhibits? [Y/N]
99【Restricted data】justified + README to obtain? [N/A or Y/N]
100【Next】est-writing-style
101```
102
103## Supplementary resources
104
105- [`../../resources/external_tools.md`](../../resources/external_tools.md) — repositories by data type; reproducibility tooling
106- [`../../resources/official-source-map.md`](../../resources/official-source-map.md) — data-availability and SI policy
107
108---
109
110**Source:** [`brycewang-stanford/Awesome-Journal-Skills`](https://github.com/brycewang-stanford/Awesome-Journal-Skills) → `Environmental-Science-and-Technology-Skills/skills/est-reporting-and-reproducibility/SKILL.md`