Skip to content

Commit 31420fe

Browse files
authored
Update README.md
Adding guidance to README for reproducing the analysis of the paper.
1 parent 8a0e4f6 commit 31420fe

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

+22-2
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,29 @@ Understanding equilibrium climate sensitivity (ECS, equilibrium warming in respo
2525
---
2626

2727
## 1. Repository Structure
28-
28+
- **`LICENSE`** – Licensing information.
2929
- **`workflows/`** – Primary analysis markdown files for workflow execution.
3030
- **`data-raw/`** – Raw input datasets required for the analysis.
3131
- **`data/`** – Processed results generated by the workflow.
3232
- **`figures/`** – Processed figures generated by the workflow.
33-
- **`LICENSE`** – Licensing information.
33+
34+
## 2. Reproducing the Analysis
35+
36+
To fully reproduce the analysis, execute each `.Rmd` file in the **`workflows/`** directory in sequential order, as indicated by their numerical prefixes.
37+
38+
Each `.Rmd` file includes detailed documentation that describes the analytical steps, methodological choices, and underlying assumptions. These embedded notes provide:
39+
- A structured overview of the objectives for each step in the workflow.
40+
- Justifications for analystical approaches.
41+
- Explanations of key statistical and computational methods used in the study.
42+
- References to relevant external sources where applicable.
43+
44+
All processed datasets generated during the analysis will be stored in the **`workflows/data/`** directory.
45+
Publication figures and any preliminary visualizations produced from the workflow will be saved in the **`workflows/figures/`** directory.
46+
47+
For a comprehensive understanding of the methodology, users are encouraged to review the `.Rmd` files alongside their execution.
48+
49+
---
50+
51+
## Repository Citation
52+
53+
Brown, J. “The Effect of Different Climate Sensitivity Priors on Projected Climate: A Probabilistic Analysis”. Zenodo, March 2, 2025. [https://doi.org/10.5281/zenodo.13943103](https://doi.org/10.5281/zenodo.13943103).

0 commit comments

Comments
 (0)