Skip to content

Commit 7068b6f

Browse files
jdhoffajacobvjk
jdhoffa
and
jacobvjk
authored
docs: remove explicit cookbook section numbering (#262)
* remove explicit cookbook section numbering * rm numbering of section at the bottom of the documents * add content list to overview section * link to following sections --------- Co-authored-by: jacobvjk <[email protected]> Co-authored-by: Jacob Kastl <[email protected]>
1 parent 0e3b5eb commit 7068b6f

File tree

5 files changed

+26
-18
lines changed

5 files changed

+26
-18
lines changed

‎vignettes/cookbook_advanced_use_cases.Rmd‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "Cookbook - (5) Advanced Use Cases"
2+
title: "Advanced Use Cases"
33
output: rmarkdown::html_vignette
44
vignette: >
5-
%\VignetteIndexEntry{Cookbook - (5) Advanced Use Cases}
5+
%\VignetteIndexEntry{Advanced Use Cases}
66
%\VignetteEngine{knitr::rmarkdown}
77
%\VignetteEncoding{UTF-8}
88
---
@@ -194,4 +194,4 @@ We can now check if:
194194
- One way to circumvent this slighlty cumbersome process would be to create a combined variable in the loan books, that includes information on both the bank and the net zero pledge. This would allow getting the required information in one run.
195195
- Any bank that we identify that has made a net zero pledge but is strongly misaligned may be at risk of losing reputation and/or being sued over noncompliance with its pledge. Of course, misalignment is rarely ever a sufficient criterion to judge if reputational damage or legal risk is likely to materialize. Other factors, such as progress made in past efforts, implementation of transition plans, lending strategy with regard to transition finance, etc. should be considered too. But strong misalignment should be considered a warning signal, that warrants further investigation into these other aspects and possibly a dialogue with the affected bank.
196196

197-
**PREVIOUS CHAPTER:** [4 - Interpretation of Results](cookbook_interpretation.html)
197+
**PREVIOUS CHAPTER:** [Interpretation of Results](cookbook_interpretation.html)

‎vignettes/cookbook_interpretation.Rmd‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "Cookbook - (4) Interpretation of Results"
2+
title: "Interpretation of Results"
33
output: rmarkdown::html_vignette
44
vignette: >
5-
%\VignetteIndexEntry{Cookbook - (4) Interpretation of Results}
5+
%\VignetteIndexEntry{Interpretation of Results}
66
%\VignetteEngine{knitr::rmarkdown}
77
%\VignetteEncoding{UTF-8}
88
---
@@ -431,6 +431,6 @@ The variables in the table map to the figures as follows:
431431
- `net`: The net aggregate alignment metric of the loan book or company. Maps to the hue of the dot. Aligned loan books or companies have a positive value (green hue), misaligned ones have a negative value (red hue).
432432
- `datapoint`: Indicates if the results are calculated at loan book or company level.
433433

434-
**PREVIOUS CHAPTER:** [3 - Running the Analysis](cookbook_running_the_analysis.html)
434+
**PREVIOUS CHAPTER:** [Running the Analysis](cookbook_running_the_analysis.html)
435435

436-
**NEXT CHAPTER:** [5 - Advanced Use Cases](cookbook_advanced_use_cases.html)
436+
**NEXT CHAPTER:** [Advanced Use Cases](cookbook_advanced_use_cases.html)

‎vignettes/cookbook_overview.Rmd‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "Cookbook - (1) Overview"
2+
title: "Overview"
33
output: rmarkdown::html_vignette
44
vignette: >
5-
%\VignetteIndexEntry{Cookbook - (1) Overview}
5+
%\VignetteIndexEntry{Overview}
66
%\VignetteEngine{knitr::rmarkdown}
77
%\VignetteEncoding{UTF-8}
88
---
@@ -49,6 +49,14 @@ plot_table <- function(table) {
4949

5050
This cookbook provides a step-by-step guide to running the PACTA for Supervisors analysis using the `pacta.multi.loanbook` package. The analysis is designed to help financial supervisors assess the alignment of banks' loan books with the Paris Agreement goals.
5151

52+
The sections of the cookbook are as follows:
53+
54+
1. **Overview**: This section provides an overview of the PACTA for Supervisors analysis and its main steps.
55+
2. **[Preparatory Steps](cookbook_preparatory_steps.html)**: Prepare the ABCD data and optionally a custom sector split.
56+
3. **[Running the Analysis](cookbook_running_the_analysis.html)**: Match the raw loan books to the ABCD data and run the PACTA for Supervisors analysis.
57+
4. **[Interpretation of Results](cookbook_interpretation.html)**: Interpret the results of the analysis and understand the outputs.
58+
5. **[Advanced Topics](cookbook_advanced_use_cases.html)**: Learn about advanced topics such as custom grouping of results and how to adjust the analysis parameters for best results on advanced research questions.
59+
5260
## What is the PACTA for Supervisors analysis?
5361

5462
PACTA for Supervisors is based on the PACTA methodology, which assesses the alignment of financial portfolios with climate goals utilizing forward-looking asset-based company data (ABCD) that is linked to financial assets and compares the production profiles of those companies with technology and emissions pathways from climate transition scenarios at the sector and/or technology level.
@@ -78,4 +86,4 @@ The main steps of the analysis are as follows:
7886

7987
This cookbook will guide you through each of the steps of the analysis in detail, explain the required input data sets and software, and provide guidance on how to interpret the results.
8088

81-
**NEXT CHAPTER:** [2 - Preparatory Steps](cookbook_preparatory_steps.html)
89+
**NEXT CHAPTER:** [Preparatory Steps](cookbook_preparatory_steps.html)

‎vignettes/cookbook_preparatory_steps.Rmd‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "Cookbook - (2) Preparatory Steps"
2+
title: "Preparatory Steps"
33
output: rmarkdown::html_vignette
44
vignette: >
5-
%\VignetteIndexEntry{Cookbook - (2) Preparatory Steps}
5+
%\VignetteIndexEntry{Preparatory Steps}
66
%\VignetteEngine{knitr::rmarkdown}
77
%\VignetteEncoding{UTF-8}
88
---
@@ -282,6 +282,6 @@ Before running the PACTA for Supervisors analysis, you should make sure that you
282282
- [ ] Created appropriate values for all input and ouput directories in the `config.yml` file
283283

284284

285-
**PREVIOUS CHAPTER:** [1 - Overview](cookbook_overview.html)
285+
**PREVIOUS CHAPTER:** [Overview](cookbook_overview.html)
286286

287-
**NEXT CHAPTER:** [3 - Running the Analysis](cookbook_running_the_analysis.html)
287+
**NEXT CHAPTER:** [Running the Analysis](cookbook_running_the_analysis.html)

‎vignettes/cookbook_running_the_analysis.Rmd‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "Cookbook - (3) Running the Analysis"
2+
title: "Running the Analysis"
33
output: rmarkdown::html_vignette
44
vignette: >
5-
%\VignetteIndexEntry{Cookbook - (3) Running the Analysis}
5+
%\VignetteIndexEntry{Running the Analysis}
66
%\VignetteEngine{knitr::rmarkdown}
77
%\VignetteEncoding{UTF-8}
88
---
@@ -182,6 +182,6 @@ All these options are documented in more detail the [section on project paramete
182182

183183
Usually, it will be interesting to run the analysis for more than one by_group, possibly also for multiple combinations of the other parameters. You will therefore have to run the analysis as many times as there are combinations of interest that you wish to generate results for.
184184

185-
**PREVIOUS CHAPTER:** [2 - Preparatory Steps](cookbook_preparatory_steps.html)
185+
**PREVIOUS CHAPTER:** [Preparatory Steps](cookbook_preparatory_steps.html)
186186

187-
**NEXT CHAPTER:** [4 - Interpretation of Results](cookbook_interpretation.html)
187+
**NEXT CHAPTER:** [Interpretation of Results](cookbook_interpretation.html)

0 commit comments

Comments
 (0)