Merge pull request #10 from worldbank/add_guidance_flagships

update: final fixes flagships

Author: mariarrt94

guidance/step_by_step_flagships.md

@@ -32,9 +32,9 @@ A reproducibility package includes everything needed to replicate the findings i
 
 | Step               | What Happens                                                                                           |
 |--------------------|--------------------------------------------------------------------------------------------------------|
-| 📨 **Submission**   | Authors prepare the reproducibility package and [submit it for verification](https://survey.wb.surveycto.com/collect/prwp_reproducibility). |
-| 🔍 **Verification** | The reproducibility team tests whether the results can be fully reproduced using the submitted code and data. A detailed verification report is issued. |
-| 🌐 **Publication**  | If reproducible, the package is published on the [Reproducible Research Repository (RRR)](https://reproducibility.worldbank.org) with a DOI, metadata, and verification seal. |
+| **Submission**   | Authors prepare the reproducibility package and [submit it for verification](https://survey.wb.surveycto.com/collect/prwp_reproducibility). |
+| **Verification** | The reproducibility team tests whether the results can be fully reproduced using the submitted code and data. A detailed verification report is issued. |
+| **Publication**  | If reproducible, the package is published on the [Reproducible Research Repository (RRR)](https://reproducibility.worldbank.org) with a DOI, metadata, and verification seal. |
 
 
 ---
@@ -45,11 +45,11 @@ A reproducibility package includes everything needed to replicate the findings i
 
 | Component             | Description & Flagship-Specific Tips                                                                 |
 |----------------------|-------------------------------------------------------------------------------------------------------|
-| **README File**       | 📌 **Essential for flagships**: Provides a clear overview of the analysis and full guidance for replicators.<br><br>- Include a **list of exhibits**: indicate which are produced by the package and which come from external sources (with citations).<br>- In the same file, define **all datasets used**: include source (with URL), version, and access date.<br><br>🔗 Templates: [Markdown](https://github.com/worldbank/wb-reproducible-research-repository/blob/main/resources/README_Template.md) · [Word](https://github.com/worldbank/wb-reproducible-research-repository/raw/refs/heads/main/resources/README_Template.docx) |
-| **Data Availability Statement (DAS)** | 📌 **Flagships often use a mix of public, restricted, and internal datasets**. The DAS must:<br><br>- List **every dataset** used in the analysis, regardless of size or access level.<br>- Specify **access conditions** for each (e.g., public with URL, WB staff only with explanation of how data was obtained, etc.)<br><br>🔗 [Example DAS for Flagship](https://reproducibility.worldbank.org/index.php/catalog/250/download/731) |
-| **Code Files**        | 📁 Modular scripts organized by task (e.g., `cleaning.R`, `analysis.do`) and managed via one main script (`main.R` or `main.do`).<br><br>- List all external dependencies (e.g., R packages, ado files, Python libraries).<br>- 📌 For flagships: organize code **by chapter or module**, and ensure the full team agrees on versioning and folder structure. |
-| **Data**              | Keep **raw** and **processed** data separate.<br><br>- Document all data transformations **in code**. If manual edits were made, explain them in the README.<br>- Clean the package before submission: remove unused files.<br><br>📌 For flagships: ensure **consistent data versions** across chapters and authors. Store original data in permanent, team-accessible locations. |
-| **Final Outputs**     | Include **all raw outputs** used in the report (e.g., CSVs, graphs, LaTeX tables).<br><br>- 📌 If final outputs were sent to the design team, **document which ones**.<br>- A final verification run should confirm that report exhibits match raw outputs. |
+| **README File**       | 📌 **Essential for flagships**: Provides a clear overview of the analysis and full guidance for replicators.<br> - Include step-by-step instructions on how to run the code or replicate the findings. <br>- Include a **list of exhibits**: indicate which are produced by the package and which come from external sources (with citations).<br>- Data Availability Statement: define **all datasets used**: include source (with URL), version, and access date (more on next point).<br><br>🔗 **Use our templates**: [Markdown](https://github.com/worldbank/wb-reproducible-research-repository/blob/main/resources/README_Template.md) · [Word](https://github.com/worldbank/wb-reproducible-research-repository/raw/refs/heads/main/resources/README_Template.docx) |
+| **Data Availability Statement (DAS)** | 📌 **Flagships often use a mix of public, restricted, and internal datasets**, so this is a key component. The DAS must:<br><br>- List **every dataset** used in the analysis, regardless of size or access level.<br>- Specify **access conditions** for each (e.g., public with URL, WB staff only with explanation of how data was obtained, etc.)<br><br>🔗 [Example DAS for Flagship](https://reproducibility.worldbank.org/index.php/catalog/250/download/731) |
+| **Code Files**        | - 📁 Modular scripts organized by task (e.g., `cleaning.R`, `analysis.do`) and managed via one main script (`main.R` or `main.do`).<br>- List all external dependencies (e.g., R packages, ado files, Python libraries).<br>- 📌 For flagships: organize code **by chapter or module**, and ensure the full team agrees on versioning and folder structure. |
+| **Data**              | - Keep **raw** and **processed** data separate.<br>- Document all data transformations **in code**. If manual edits were made, explain them in the README.<br>- Clean the package before submission: remove unused files.<br>📌 For flagships: ensure **consistent data versions** across chapters and authors. Store original data in permanent, team-accessible locations. |
+| **Final Outputs**     | - Include **all raw outputs** used in the report (e.g., CSVs, graphs, LaTeX tables).<br>- 📌 If final outputs were sent to the design team, **document which ones**.<br>- A final verification run should confirm that report exhibits match raw outputs. |
 
 
 ---
@@ -67,7 +67,7 @@ A reproducibility package includes everything needed to replicate the findings i
 
 ## 🚀 Start Early: Timeline & Submission Steps
 
-| 📅 Phase               | 👥 Action Items                                                                      |
+| 📅 Phase               | Action Items                                                                      |
 |------------------------|---------------------------------------------------------------------------------------|
 | **Kickoff**            | - Assign a reproducibility lead per chapter or module<br>- Define folder and file structure for the whole team<br>- Align on data sources and archive raw versions from day 1 |
 | **During project**     | - Update README and DAS progressively<br>- Automate figures/tables as much as possible<br>- Keep scripts modular and coordinated across chapters |